Add Endpoints Documentation with rswag
#194
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
juanarias93
changed the title
rswagrswag
juanarias93
changed the title
rswagrswag
juanarias93
force-pushed
the
juan_arias--add_endpoints_documentation
branch
6 times, most recently
from
28fdf6d to
057aa2e
Compare
* bundle exec rails g rswag:api:install * bundle exec rails g rswag:ui:install * RAILS_ENV=test bundle exec rails g rswag:specs:install
juanarias93
force-pushed
the
juan_arias--add_endpoints_documentation
branch
from
91a0045 to
8ca4c79
Compare
juanarias93
changed the title
rswagrswag
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.
What && Why
Add Swagger-based
rswaggem for documenting BE endpoints.Disclaimers / Extra comments
Documentation will be accessible via UI on: http://localhost:3000/api-docs (or for example on https://finder-backend-qa.onrender.com/api-docs for the QA environment).
Run
SWAGGER_DRY_RUN=0 RAILS_ENV=test rails rswagin order to re-generate theswagger.jsonfile.Important: Generated documentation takes into account only the
successscenarios, enough for hitting the application endpoints properly. Eventually, the rest of the tests/docs can be added, if needed.Coverage was not affected, since this only added some extra specs under
spec/api/for the endpoints documentation. We're still at98.45%.How
rswaggem.spec/api/for all controllers.swagger.jsonfile with all endpoint's docs.Links
How to Review
Screenshots
Screen-recording
Screen.Recording.2023-11-10.at.8.55.44.PM.mov