Basic API Information

When configuring a new API in the API Modeler, you define its basic metadata. This metadata serves two critical purposes:

1. Self-Documentation: It is compiled directly into the generated OpenAPI Specification (OAS) file, providing consumers of your API with clear documentation.
2. Design Validation: The platform evaluates this metadata against design standards during model validation.

---

Core Metadata Fields

You configure the following metadata on the API’s settings panel:

• Name (info.name): The human-readable name of the API (e.g., Task Management API). This is required; saving an API without a name will trigger an error.
• Description (info.description): A brief overview of what the API does. Providing a description is highly recommended (the linter will flag a warning if it is missing).
• Version (info.version): The semantic release version of the API configuration (e.g., 1.0.0).

---

Contact & Support Info

Providing contact details helps consumers of your API find support. The platform validates these fields for proper formatting:

• Contact Name: Identifying name of the contact person or team.
• Contact Email (contact.email): Must be formatted as a valid email address (e.g., support@example.com). Invalid formats trigger a validation error.
• Contact URL (contact.url): Must be formatted as a valid URL pointing to contact details or a support portal.

---

Licensing & Terms

To publish your API professionally, you can configure terms of service and licensing details:

• Terms of Service URL: A URL pointing to your API’s terms of service agreement.
• License Name: The name of the license under which the API is made available (e.g., MIT or Apache 2.0).
• License URL (license.url): Must be formatted as a valid URL containing the license agreement terms.