Service Metadata

The metadata section allows you to specify all info about the current service.

This information will be published in an online documentation for the service, known as the OpenAPI Specification.

Fields

A service metadata contains the following fields to be defined:

Version

The version number of current service.

Example:

1 2	`Metadata: Version: v1`

Title

A title for this service. Usually the service name.

Example:

1
2
3

Metadata:
  Version: v1
  Title: My_First_Service WebApi

Description

A brief description explaining the purpose of this service.

Example:

Metadata:
  Version: v1
  Title: My_First_Service WebApi
  Description: A Rest Api for customers CRUD

TermsOfServiceUrl

A URL containing the Terms of Service for third parties to use this service.

Requirements Rules:

Must be a valid URI pattern

Example:

Metadata:
  Version: v1
  Title: My_First_Service WebApi
  Description: A Rest Api for customers CRUD
  TermsOfServiceUrl: https://mydomain.com/my-first-service/service-terms

Contact

A set of technical contact information for this service.

Partners or other developers will be able to contact you through this information.

Requirements Rules:

Must follows rules as specified in Contact

Example:

Metadata:
  Version: v1
  Title: My_First_Service WebApi
  Description: A Rest Api for customers CRUD
  TermsOfServiceUrl: https://mydomain.com/my-first-service/service-terms
  Contact:
    ContactName: My_First_Service WebApi Team
    ...

License

A set of information regarding the license to use this service by third parties.

Requirements Rules:

Must follows rules as specified in License

Example:

Metadata:
  Version: v1
  Title: My_First_Service WebApi
  Description: A Rest Api for customers CRUD
  TermsOfServiceUrl: https://mydomain.com/my-first-service/service-terms
  Contact:
    ContactName: My_First_Service WebApi Team
    ...
  License:
    LicenseInfo: Use under MIT
    ...