Skip to content

Use API Umbrella for REST calls made through Swagger UI #517

@bajiat

Description

@bajiat

When making API calls in documentation browser, i.e. Swagger UI, it is desirable to use API Umbrella proxy, e.g. umbrella.apinf.io, for requests.

The API Umbrella proxy URL can be found in config.json (as api_umbrella.base_url)

One approach to this task would be to rewrite the .swagger file, changing the host property to match the api_umbrella.base_url.

Task

  • Determine how to change .swagger file to use api_umbrella.base_url for the API Base URL
    • Specifically, the host in the .swagger file should be set to the same value as api_umbrella.base_url
  • Test that API Calls through Swagger UI are being sent to API Umbrella

Reference

Check the Swagger specification for information about the host property.

Related

Related to #76.

Co-pilot: @elnzv

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions