Profile image forGray Brooks

Gray Brooks

GSA

Latest Content by Gray Brooks

API Design and Documentation

Design At their core, developers want APIs for very straightforward, pragmatic ends. You should always design your APIs and document them with the goal of making it easier for developers to use them. Doing so results in greater adoption and a healthier, more successful API. The least efficient way to support developers would be to

Mar 12, 2013

How to Make APIs—An Overview

After choosing a set of information or services to offer via API, some of your next steps are to plan and implement the API. You’ll still need to prepare documentation, tools, and other elements that make a complete package for the API, but at the center is the actual Web service itself. In many situations,

Mar 12, 2013

Resources and Tools for APIs

Hosted API Tools Labs.Data.gov is a repository of shared services to prototype and provide developer resources to government agencies. Each tool uses Web services and lightweight, open source code to provide powerful functionality. Agencies are encouraged to improve any project and submit pull requests in order to share the improvements with others. API Standards Template With the open

Mar 12, 2013

How to Get Started with APIs

Audit Research existing APIs Regardless of your agency’s level of progress in API production, your first step is to create a developer hub that links to any of your agency’s existing APIs. This can help identify current efforts and connect you with others in your agency already working on APIs. Follow up with a deeper

Mar 12, 2013

API Basics

Common Technical Choices Protocol API protocol is the set of rules that govern how an API functions. The protocol outlines the structure and definitions of the API. The two common forms are REST and SOAP. REST is the dominant choice for API protocol because it uses the http protocol that powers the Web. REST supports more

Mar 12, 2013

Benefits of APIs

Understanding the benefits of API production allows you to coordinate with system owners and other stakeholders to modernize the agency’s systems and unlock the sizable potential. Here are just some of these opportunities. Efficiency Providing API access allows for content to be created once and automatically published or made available to many channels. Your agency’s

Mar 12, 2013

Introduction to APIs

There’s an easier way to get content and data into the hands of citizens. Application Programming Interfaces, or APIs, are web services that allow people to more easily consume content and data in multiple ways–via mobile devices, mobile apps, innovative mash-ups, and much more. Simply put, “APIs are a better way to get government information

Jul 26, 2012