Skip to main content

GSA Tech Guides

All guides » API guides

API Documentation Template

The GSA API Documentation Template is an open source template that business/IT offices can use to assist with documentation of RESTful APIs. It is a template that can be cloned, changed, and posted for support of API consumption.

It was developed to provide a consistent look and feel for GSA APIs. It is based on excellent work from the Consumer Financial Protection Bureau and GSA’s 18F organization, along with best practices from private industry.

To use this template, follow the instructions for cloning the project in this GitHub repository:

https://github.com/GSA/api-documentation-template

You can see a working version of this template at the following location:

https://gsa.github.io/api-documentation-template/api-docs/