Show API documentation at /api/ #2650
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
October 18, 2023 03:12
It is shown in development, but not in production and can be turned on/off with config.featureFlags.apidocs Generated with swagger-autogen Displayed with Swagger-UI v5.9.0 https://github.com/swagger-api/swagger-ui The documentation gets updated in pre-commit hook
to get rid of workflows error
|
Tried it locally, looks fine to me (although I have no idea what I should see :) ) |
JohnvdWaeter
approved these changes
Oct 18, 2023
If you go to http://localhost:3000/api/, you should be able to see the Swagger documentation of Trustroots API |
|
Yes, that works! |
|
Ok, great! Thank you for testing @JohnvdWaeter! |
|
Proceeding with the merge, since b7b9725 was deployed. ✅ |
mrkvon
added a commit
that referenced
this pull request
Jan 16, 2024
It is shown in development, but not in production and can be turned on/off with config.featureFlags.apidocs Generated with swagger-autogen https://www.npmjs.com/package/swagger-autogen Displayed with Swagger-UI v5.9.0 https://github.com/swagger-api/swagger-ui The documentation gets updated in pre-commit hook
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
npm run generate-api-docs(the documentation isn't perfect, but it's good enough, much better than doing it manually) using swagger-autogen/api/path{ featureFlags: { apidocs: true } }in./config/env/local.jsThe OpenAPI json, and files for Swagger-UI are stored in /apidocs/ folder. It can be moved elsewhere if somebody prefers
Motivation
For people who want to develop e.g. mobile app on top of Trustroots API, this can be useful resource
Testing instructions
Update node_modules by running
npm ciTry to delete
/apidocs/openapi.json, then runnpm run generate-api-docs, and it should re-appearRun the app locally, and go to http://localhost:3000/api/, and you should see
If running the whole app locally is too much for you, you can
sudo npm install -g http-servergit switch api-docscd apidocs/http-server