Swagger™ is a specification and framework implementation for describing, producing, consuming, and visualizing RESTful web services.
To read more about Swagger, refer to:
The Swagger Editor lets you design your API specification and preview its documentation for your swagger API. The editor is installed with swagger.
A swagger.yaml file is installed into every new swagger project, and lives in <project_root>/api/swagger/swagger.yaml. It conforms to the OpenAPI 2.0 Specification.
Behind the scenes, Swagger middleware validates and processes the Swagger configuration file, and routes API operation endpoints to controller files. All you need to do is implement your custom API controller logic.
Note: The editor is served locally and automatically saves your work as you edit. In addition, if the project is running (
swagger project start), it is automatically restarted each time the editor saves. Just be careful if you kill the editor, that you do not lose unsaved work.
Try it:
swagger project create test-projectcd test-projectswagger project edit
The Swagger editor
YAML is a data serialization/representation standard. If you're new to YAML, check out www.yaml.org. Another excellent introduction is the Wikipedia YAML entry.
YAML is intended to be easy for humans to read. Every swagger project includes a Swagger 2.0 compliant configuration file that is written in YAML.
For a more detailed look the Swagger configurations, see "The OpenAPI Specification file".