Adding documentation for HTTP Rest API (Swagger)#274
Open
nerma-now wants to merge 4 commits intoPhineas:mainfrom
Open
Adding documentation for HTTP Rest API (Swagger)#274nerma-now wants to merge 4 commits intoPhineas:mainfrom
nerma-now wants to merge 4 commits intoPhineas:mainfrom
Conversation
This file contains hidden or 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
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.
This PR is intended to make working with the service easier by structuring and visualizing the endpoints the HTTP API works with. People are much more comfortable when they can poke around in something themselves without unnecessary programs and hassles.
The open_api_spex library and Swagger with OpenAPI were used to create the documentation.