Improving OpenAPIs

Steps to improve APIs

With API Assistant you can now improve APIs in the following ways:
  • Specification enhancements: Enhance your API documentation by analyzing your API definition, and generating recommendations for your descriptions and examples.
    Augment the following openapi with enhanced descriptions and examples @openapi-sample.yaml

    or from a Draft API (with API name:version)

    Augment the following openapi with enhanced descriptions and examples openapi-sample:1.0.0
  • Specification validation errors: Improve your APIs by analyzing your OpenAPI 3.0 specification, and generating potential API corrections for any validation errors.
    Correct the validation errors in the following openapi file @openapi-sample.yaml

    or from a Draft API (with API name:version)

    Correct the validation errors in the following openapi file openapi-sample:1.0.0

These API Assistant capabilities are available in the API Manager UI. For more details, see Using the API Assistant to improve your API specifications.

To start these capabilities from the conversational API Assistant, complete the following steps:
  1. Log into API Assistant.
  2. Enter the following prompt, and click Send.
    Augment the following openapi with enhanced descriptions and examples @openapi-sample.yaml

    The OpenAPIEnhancer tool displays the proposed plan with improved descriptions and examples.

  3. Enter the following prompt, and click Send.
    Correct the validation errors in the following openapi file @myapi.json

    The enhanced OpenAPI file is displayed containing generated API fixes for any validation errors found in the file.

  4. To display the enhanced OpenAPI, click Start.