diff --git a/modules/ROOT/pages/omni-create-manage-apis.adoc b/modules/ROOT/pages/omni-create-manage-apis.adoc new file mode 100644 index 000000000..b9d63e896 --- /dev/null +++ b/modules/ROOT/pages/omni-create-manage-apis.adoc @@ -0,0 +1,86 @@ += Create and Manage APIs in Omni + +In Omni, APIs are registered as services defined by formal specifications and managed within a unified experience alongside other service types. + +Creating an API establishes its structure and makes it available in the portfolio, while instances represent deployed or managed versions of that API across environments or providers. + +== Create an API + +To create an API in Omni, add it to the APIs catalog either by registering it manually or by connecting to a provider. + +* *Register manually* – Upload a specification file to define a new API. +* *Connect to provider* – Discover and import APIs from external platforms. See xref:omni-connect-providers-to-add-services.adoc[]. + +Creating an API defines its structure and makes it available in the portfolio for management and operations. + +=== Register an API Manually + +When you register an API manually, you provide a specification file that defines the API structure, including endpoints, operations, and data types. + +. In the navigation pane, select *APIs*. +. Click *Add API*. +. Select *Register manually*. +. Enter a name for the API. +. Select the API type. +. Upload the specification file. +. Click *Create*. + +Omni supports multiple API types and specification formats: + +* REST APIs (OAS, RAML) +* gRPC APIs (Proto files) +* Async APIs (AsyncAPI specification) + +== View API Details + +After creating or selecting an API, Omni displays its details as a service with multiple views that expose its structure, runtime state, and governance status. + +The API view is organized into tabs: + +* *Overview* – Displays API structure and metadata +* *Instances* – Lists and manages API instances +* *Monitoring* – Displays performance metrics +* *Policies* – Displays applied policies +* *Conformance Report* – Displays governance status +* *Versions* – Displays available API versions + +NOTE: Monitoring, policies, and conformance details are managed in their respective sections. + +=== Overview Tab + +The *Overview* tab displays information derived from the API specification. + +Depending on the API type, this includes: + +* Endpoints or resources defined in the API +* Available methods (such as GET, POST, PUT, and DELETE) +* Request and response details +* Parameters and headers +* Example requests and responses +* Data types and schemas +* Security definitions + +This view reflects the structure and behavior defined in the uploaded specification. + +== Create and Manage API Instances + +API instances represent concrete deployments or runtime configurations of an API across environments or providers. + +Use the *Instances* tab to: + +* View existing instances +* Create new instances +* Manage or remove instances + +Each instance corresponds to a specific deployment or configuration of the API. + +Instances enable you to apply runtime-specific configurations and interact with APIs across different environments. + +API instances enable you to manage runtime behavior and interact with APIs within the unified Omni experience. + +== See Also + +* xref:omni-add-services-to-portfolio.adoc[] +* xref:omni-register-services-manually.adoc[] +* xref:omni-connect-providers-to-add-services.adoc[] +* xref:omni-view-service-details.adoc[] \ No newline at end of file