SWAGGER-DOCUMENTATION.md

Swagger - Documentation

Dynamic API Documentation

Depending on the language you will have variant ways of documenting your project, being possible via method documentation, annotations or JSON or YML files, in the project templates it will be possible to find different examples of this approach.

Diagram

Schemas

to be documented

Routes

to be documented

UI

to be documented

Examples

To view examples of these files go to:

• openapi.yml
• UI
  • UI
• Routes
  • PHP - Routes
  • Python - Routes
• Schemas
  • PHP
    • Schemas - API
    • Schemas - Product
  • Python
    • Schemas - API
    • Schemas - General

Reference to route documentation

The material that can be used to generate the inline documentation can be found here: https://swagger.io/specification/

OpenAPI Documentation default route

Your documentation should be in the docs link by default.

Route example:

http://localhost/docs

Configuration document

the file with the specification must be located or in the docs folder with the following name: openapi.yml. The same can be mapped in the routes /docs/openapi.yml or /openapi.yml

http://localhost/openapi.yml
http://localhost/docs/openapi.yml

WIP

finish documenting