Create or upload an API definition 编辑
Create or upload an API definition
An API definition is a document that describes an API using OpenAPI Specification standards (Swagger 2.0, OpenApi 3.0.x). This definition can contain API resource paths and methods to operate them. You can add API definitions to Citrix ADM then deploy them to an API gateway (Citrix ADC).
You can create API definitions in one of the following ways:
Note
Currently, Citrix ADM supports parsing OAS specification files that use Swagger 2.0 or openapi 3.0.1.
Upload the OAS specification
You can upload the OAS specification to the Citrix ADM GUI.
Navigate to Security > API Gateway > API Definitions.
Click Add.
Select Upload OAS Specification.
Note
Ensure the OAS Specification file is in YAML or JSON format. And, this file must not contain external references. Currently, Citrix ADM supports Swagger version 2.0.
Browse an OAS specification from your local computer and upload to Citrix ADM.
Create an API definition
You can create your own API definition in the Citrix ADM GUI.
Navigate to Security > API Gateway > API Definitions.
Click Add.
Select Create Your Definition and specify the following:
Name - A name for the API definition.
API Definition - A definition must include title, version, base path, and host. You can specify a domain name or IP address in the Host field.
API Resources - Add multiple API resources to your definition. Each resource has a path and supported method.
Click Create.
View API definitions
The API Definitions page lists the uploaded definition. Click View to see the following API definition details:
Name – Displays the name of an API definition.
API Definition – Displays title, version, base path, and host of a definition.
API resources – Lists the API resources in an API definition and their methods to operate them.
Next, deploy this definition to an API gateway.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论