Add self-referencing Swagger file to API Umbrella for Admin API

[brylie]

We are currently maintaining a Meteor.js integration package for API Umbrella Admin API. When we started the project, the Admin API did not have significant documentation, nor a Swagger description file. The API Umbrella project now has a generic Swagger description file for the Admin API.

As an extension, we would like to use the swagger.js to automatically interface with an API Umbrella instance, so that we can deprecate our Meteor.js package. To this end, we have created an upstream feature request, and will begin working to provide this functionality as an upstream contribution.

Definition of done

• Create/reuse a repository in apinf organization containing a fork of API Umbrella
• Add modifications to the fork to meet the following criteria
  • API Umbrella should have a route to serve a self-referencing swagger.json
  • That swagger.json should document most or all Admin API endpoints
  • The swagger.json base URL should be set automatically to the current deployment URL
  • Optionally, use static documentation or autogenerate swagger.json

Resources

API Umbrella

• API Umbrella feature request related to this task
• API Umbrella Admin API documentation
  • swagger.yaml
• API Umbrella sourcecode: Admin API V1

Swagger / OpenAPI Spec

• Swagger.js

Apinf

• Apinf: Meteor API Umbrella module - to be deprecated

[brylie]

@bajiat this would still be useful for integration purposes. It might mean that we could deprecate our Meteor Swagger package in favor of using a generic Swagger API integration library.

[brylie]

Adding multi-proxy tag, since this is related to the API Umbrella integration.

[bajiat]

@shaliko This is a task that would be immediately useful for us and probably requires looking at Api Umbrella source code. Could you look into this? If you wan more details, we can have a meeting or we can use chat to discuss. @brylie would be able to explain in more detail.

[shaliko]

@bajiat @brylie OK, will be good have a meeting.