API Definition with Swagger and YAML

Swagger Installation: npm install -g swagger

Project Creation: swagger project create <project_name>

Start Project: swagger project start

Edit Project: swagger project edit

The notation is defined within the OpenAPI Specification. Visual representation of the specification by Arnaud Lauret: Link

API Definition (excerpt): Download swagger.yaml

Verify YAML code: swagger project verify

Include mock file In the project folder under the ‘mocks’ directory create a new mock file e.g. getAllEntries.js .

The mock file must then be included within the project:

The API must be adjusted as follows:

Start project in mock mode: swagger project start -m

Postman output:

Links: Online Editor: http://editor.swagger.io