Michael's Portfolio API

The Portfolio API allows a user to create and manage API documentation. The API is a 'work-in-progress' as there will be much more added to the API. Currently, you can upload an OpenAPI document to the service if you own the API. I don't yet have a way to create a new API. You can create backups, list the backup and restore backups of the tables that store the API information. To use this API, you need to register credentials to authenticate yourself as a valid user. The only data collected at the registration is a username and a password. No other personal data is asked for. To try the Personalized Greeting API, you can view the interactive API documentation. The purpose of the Portfolio API is to demonstrate how to document APIs with security controls when you have more than one API hosted on a web domain.

The API provides several links to help you get started. The link for the interactive API allows developers to experiment with the API by providing credentials and trying the methods. There are other methods in the API for retrieving the documentation. Developers can try those methods as well. One such method is an OpenAPI JSON document. Use the OpenAPI document with your favorite API stub tools to generate a stub that your own program can use to call the Portfolio API.

The Open GeoSpatial Consortium (OGC) is an organization that develops GeoSpatial standards. I am a co-chair on a Standards Working group that is writing a standard to document security controls. One existing standard that OGC provides is the OGC API Commons Specification that defines conformance classes for documentation. Conformance classes are testable requirements that an API or web service may implement. Click here for a list of conformance requirements that this API adheres to.