Posted on 07-15-2014
Using 18F’s own description:
This document captures 18F's view of API best practices and standards. We aim to incorporate as many of them as possible into our work.
APIs, like other web applications, will vary greatly in implementation and design, depending on the situation and the problem the application is solving.
I like the mix of info that is delivered as well:
- High level design guidance that individual APIs interpret to meet their needs.
- Low level web practices that most modern HTTP APIs use.
To top it off, the API Standards is hosted on Github, in its own repository, and as Gray Brooks from 18F says:
"Want a formal API Standards for your agency to adopt? Fork ours, add your name to the top, and make it your own."
Simple guidance like this goes a long way in helping, sometimes even very experienced developers, understand the best practices when it comes to designing, simple, modern APIs—a world where consistency and simplicity goes a long way!
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- Swagger Visualization Layer Using D3.js
- Establishing Common Dictionaries That Industries Can Use In Their API Design
- Top 5 Most Popular Themes On API Evangelist In 2014
- Query Parameter Determining Which Fields Are Queried For API Call
- Now Our Development Environment Is Now Containerized And Scalable Like Our Production Environment
- Guest Post: Let Our Sponsors Blow A Little Smoke Up Your Ass
- API Discovery Continues Its Move Into The IDE With Eclipse Che
- Evolving Beyond Just Resources Towards A More Experience Based API Design
- Another View of The API vs. Data Download Model
- If You Have A Publicly Available Mobile App You Have a Public API