Open Source API Documentation
What Do You Mean ‘Open Source API Documentation’
API documentation that is not only open sourced for easy collobartion and re-use but is also hosted for free as an open source project, so that anyone can create a hosted copy of their own in seconds, not hours or days.
Why (Re)Use Open Source Documentation?
This model has a range of benefits, discussed in greater detail in the case study and webinar linked in the Resources section below. Some of those benefits include:
- Ease of setup and maintenance
- Free hosting
- More developer friendly
- Great issue tracking and version control built in
- Allows teammates and eager supporters to more easily help you by directly proposing improvements
- Strong access controls
- Serving as a solid example of open government best practices
Examples of API Documentation or Developer Hubs Hosted as Open Source Documentation
- CFPB’s Developer Hub
- GSA’s Developer Hub
- CFPB API Documentation
- Code.gov API
- SAM.gov API
- GSA Auctions API
- Open IAE
- OpenFDA
- Regulations.gov
- NIH 3D Printing API
- DOL Developer Documentation
- API.Data.gov
- API.Data.gov Admin
- Developer.Trade.Gov
- DOI Data Hub - APIs
- DigitalGov Search APIs
- FBOpen API
- PyArt
- NIEM Developer Hub
- HHS Pillbox API
- Blue Button Connector
- Census Bureau CitySDK
- NASA API docs
- CMS Quality Payment Program API
Notes
- Case Study
- Clonable Templates for API Documentation, Developer Hubs, and other microsites
- Another Clonable Template with Directions
- Webinar
- Other examples of open source microsites