From f453f0c37edfa49f8a93ce90ee0bc78147319f29 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Sat, 23 Apr 2022 12:09:02 +0800 Subject: [PATCH] docs: add swagger ui info Signed-off-by: Wing-Kam Wong --- .../en/developer-resources/accessing-apis.md | 32 +++++++++---------- .../en/developer-resources/rest-apis.md | 6 ++-- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/packages/noco-docs/content/en/developer-resources/accessing-apis.md b/packages/noco-docs/content/en/developer-resources/accessing-apis.md index fc00a3716a..f2dbe3e1b0 100644 --- a/packages/noco-docs/content/en/developer-resources/accessing-apis.md +++ b/packages/noco-docs/content/en/developer-resources/accessing-apis.md @@ -14,22 +14,7 @@ Auth Token is a JWT Token generated based on the logged-in user. By default, the - Go to NocoDB Project, click the rightmost button and click ``Copy Auth Token``. -![image](https://user-images.githubusercontent.com/35857179/161957971-e4888983-25e1-46a4-8419-7b9fae6cb6fa.png) - -- Click the same button and click ``Swagger APIs Doc``. - - - -![image](https://user-images.githubusercontent.com/35857179/126187534-32c41de9-f17d-4f95-9acc-88aaed044b36.png) - -- Select ``Schemes`` and Click ``Authorize``. - -![image](https://user-images.githubusercontent.com/35857179/126188482-f3aacabf-dbc5-41a8-a190-9f225347ebd1.png) - -- Paste the token you just copy in step 1 and click Authorize - -![image](https://user-images.githubusercontent.com/35857179/126188510-b3790348-6809-4182-911a-a4031ace2fd2.png) - +image ## API Token @@ -49,4 +34,17 @@ NocoDB allows creating API tokens which allow it to be integrated seamlessly wit ![image](https://user-images.githubusercontent.com/35857179/161958676-e4faa321-13ca-4b11-8d22-1332c522dde7.png) - Copy API token to your clipboard - ![image](https://user-images.githubusercontent.com/35857179/161958822-b0689a6a-a864-429f-8bb2-71eb92808339.png) \ No newline at end of file + ![image](https://user-images.githubusercontent.com/35857179/161958822-b0689a6a-a864-429f-8bb2-71eb92808339.png) + +## Swagger UI + +You can interact with the API's resources via Swagger UI. + +- Go to NocoDB Project, click the rightmost button and click ``Swagger APIs Doc``. + +image + +- Click ``Authorize``, paste the token you copied in above steps and click `Authorize` to save. + +![image](https://user-images.githubusercontent.com/35857179/164874471-29fc1630-ab99-4c25-8ce2-b41e5415e4be.png) + diff --git a/packages/noco-docs/content/en/developer-resources/rest-apis.md b/packages/noco-docs/content/en/developer-resources/rest-apis.md index 71b2d73212..fd1c9838a7 100644 --- a/packages/noco-docs/content/en/developer-resources/rest-apis.md +++ b/packages/noco-docs/content/en/developer-resources/rest-apis.md @@ -9,11 +9,9 @@ Once you've created the schemas, you can manipulate the data or invoke actions u ## API Overview -Here's the overview of all APIs. For the details, please check out NocoDB API Documentation. +Here's the overview of all APIs. For the details, please check out NocoDB API Documentation. - -Swagger UI has been removed from GUI and may be supported in the future release. - +You may also interact with the API's resources via Swagger UI. Currently, the default value for {orgs} is noco. Users will be able to change it in the future release.