FAQ

Frequently Asked Questions

How can I add or amend an API in the collection?

Check out the CONTRIBUTING guide.

Are these definitions officially supported by those companies?

Around 95% of the collection is officially produced by the API owners, either in OpenAPI (Swagger) format, or converted from another format (e.g. RAML, API Blueprint, WADL, IO Docs, Google API discovery format). Unofficial/third-party definitions are marked x-unofficialSpec: true. Support from API vendors may differ from vendor to vendor.

What percentage of the directory is from each vendor?

See this chart

Do you have any plan to add Facebook or some other important APIs?

Yes definitely. But in order to add API into the collection, we need to have a link to API specification in one of the popular formats (RAML, OpenAPI/Swagger, WADL, ...). If you can send us such URLs to API that you require, we will add it to the collection. The purpose of this project is to aggregate existing API specs. So, if you want to help you can write a scraper which converts official HTML docs into an OpenAPI document.

What about Stripe and Twitter

Both these APIs were added on 2017/11/14.

What about AWS?

The work to convert AWS definitions to OpenAPI 2 has been done but the next stage is to validate the conversions and test things like the security requirements have been modelled as well as possible. Help would be appreciated by users of the various AWS APIs.

AWS APIs were added to the collection on 2017/05/02. Help would still be appreciated in testing them, especially with regards to security.

How do I make my API discoverable?

APIs.guru recommends use of the Schema.Org WebAPI annotation to link to your API definition. Other options exist, such as the APIs.json format.