Working with API project

To start building your API select it from the designer workspace and you will be presented with a set of options where you can

Project Setting

You can set some basic information about your project like API host name, API base path and Allowed protocols, under the Settings panel in your projects home screen.

Folders can be used to group and organize related components in one place.

Have a schema that you want to reuse in multiple places? Create a Model. Models represent schema objects that allow the definition of input and output data types. Should be used to reduce duplication. Models can be reused with other models, in traits or with endpoints. Use $ref to refer an existing model.

Traits will help you to define generic request and response patterns like query parameters, headers, response types (200, 404) ect and their respective response schemas. You can reuse them with endpoints.

Endpoinst are your actual APIs.You can define your API endpoints in your project with request, response types, response schemas etc.

What's next?

Next we will design APIs for a ToDo Application. But first let's get organized by creating a folder.

Last updated