user-docs
user-docs copied to clipboard
[Request] Rework entire API to follow OpenAPI specification.
Why it should be done:
1) Use Swagger Codegen to generate a server stub for your API. The only thing left is to implement the server logic.
2) Use Swagger Codegen to generate client libraries for your API in over 40 languages.
3) Use Swagger UI to generate interactive API documentation that lets your users try out the API calls directly in the browser.
4) Use the spec to connect API-related tools to your API. For example, import the spec to SoapUI to create automated tests for your API.
API specifications can be written in YAML or JSON. The format is easy to learn and readable to both humans and machines. The complete OpenAPI Specification can be found on GitHub: OpenAPI 3.0 Specification
There is absolutely no way how reworking your API into OpenAPI specification can harm your product, it can only make it better.