API definition header section

Let's start with the header part of the OpenAPI definition. Here is the OpenAPI header from our example Time API, and below it is a description of the header fields:

openapi: 3.0.1 info: title: Time API description: Simple API providing current time version: 1.0.0 servers: - url: /api/time/v1

OpenAPI object	Description
openapi: 3.0.1	OpenAPI version. Currently, Frends supports OpenAPI v3.0.1 and older versions.
info: title: Time API description: Simple API providing current time version: 1.0.0	title: The title of the API, which will be displayed as the name of the API on the Frends API tab. description: This is a purely documentary property that explains why the API exists. version: This indicates the version of the API. If there are changes that are not backwards compatible, a new version of the API needs to be created. For more detailed documentation on the info object, please refer to this link.
servers: - url: /api/time/v1	Here you define the relative path to the API. The absolute path can be seen after the OpenAPI definition is saved or published to an Agent.

The next article is Introduction to API Paths section

Best practices on Versioning of APIs

Introduction to Building your first API and API definition

Example on Building your first API definition

Introduction to API Paths section

Introduction to Defining the use of API Key on OpenAPI Specification