Skip to content

Commit 77e44d6

Browse files
authored
Merge pull request #412 from mulesoft/W-22341778-omni-apim-fa
W-22341778-omni-apim-fa
2 parents f881afa + 661ffcb commit 77e44d6

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
= Create and Manage APIs in Omni
2+
3+
In Omni, APIs are registered as services defined by formal specifications and managed within a unified experience alongside other service types.
4+
5+
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.
6+
7+
== Create an API
8+
9+
To create an API in Omni, add it to the APIs catalog either by registering it manually or by connecting to a provider.
10+
11+
* *Register manually* – Upload a specification file to define a new API.
12+
* *Connect to provider* – Discover and import APIs from external platforms. See xref:omni-connect-providers-to-add-services.adoc[].
13+
14+
Creating an API defines its structure and makes it available in the portfolio for management and operations.
15+
16+
=== Register an API Manually
17+
18+
When you register an API manually, you provide a specification file that defines the API structure, including endpoints, operations, and data types.
19+
20+
. In the navigation pane, select *APIs*.
21+
. Click *Add API*.
22+
. Select *Register manually*.
23+
. Enter a name for the API.
24+
. Select the API type.
25+
. Upload the specification file.
26+
. Click *Create*.
27+
28+
Omni supports multiple API types and specification formats:
29+
30+
* REST APIs (OAS, RAML)
31+
* gRPC APIs (Proto files)
32+
* Async APIs (AsyncAPI specification)
33+
34+
== View API Details
35+
36+
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.
37+
38+
The API view is organized into tabs:
39+
40+
* *Overview* – Displays API structure and metadata
41+
* *Instances* – Lists and manages API instances
42+
* *Monitoring* – Displays performance metrics
43+
* *Policies* – Displays applied policies
44+
* *Conformance Report* – Displays governance status
45+
* *Versions* – Displays available API versions
46+
47+
NOTE: Monitoring, policies, and conformance details are managed in their respective sections.
48+
49+
=== Overview Tab
50+
51+
The *Overview* tab displays information derived from the API specification.
52+
53+
Depending on the API type, this includes:
54+
55+
* Endpoints or resources defined in the API
56+
* Available methods (such as GET, POST, PUT, and DELETE)
57+
* Request and response details
58+
* Parameters and headers
59+
* Example requests and responses
60+
* Data types and schemas
61+
* Security definitions
62+
63+
This view reflects the structure and behavior defined in the uploaded specification.
64+
65+
== Create and Manage API Instances
66+
67+
API instances represent concrete deployments or runtime configurations of an API across environments or providers.
68+
69+
Use the *Instances* tab to:
70+
71+
* View existing instances
72+
* Create new instances
73+
* Manage or remove instances
74+
75+
Each instance corresponds to a specific deployment or configuration of the API.
76+
77+
Instances enable you to apply runtime-specific configurations and interact with APIs across different environments.
78+
79+
API instances enable you to manage runtime behavior and interact with APIs within the unified Omni experience.
80+
81+
== See Also
82+
83+
* xref:omni-add-services-to-portfolio.adoc[]
84+
* xref:omni-register-services-manually.adoc[]
85+
* xref:omni-connect-providers-to-add-services.adoc[]
86+
* xref:omni-view-service-details.adoc[]

0 commit comments

Comments
 (0)