The API Briefing: Quick Guide to Using GitHub – FDA’s OpenFDA Research Project

250-x-289-Open-Data-Open-Source-Open-community-openFDA
The Food and Drug Administration (FDA) just released the OpenFDA Research Project. At the heart of the project is the OpenFDA API, which allows developers to perform searches on FDA’s drug information database. Coming soon is the ability to search FDA information on medical devices and information about food. Visit the FDA’s API Basics page to learn how to access OpenFDA including interactive sample queries. The FDA’s API documentation is a great example of how to create detailed guidance for developers.

Like other agencies, the FDA has created a GitHub repository that contains the code and documentation for the API. The advantage of using GitHub for agency APIs, is that it’s an easy way for developers to copy the code and make improvements that can then be added back to the original code. Being able to use GitHub is essential for developers but it can be intimidating. Here is a two-part tutorial I use in introducing people to GitHub concepts:

1) GitHub for Beginners (Part 1): Don’t Get Scared, Get Started

2) GitHub for Beginners (Part 2): Commit, Push, and Go

Once you have the basics down, try this interactive 15-minute tutorial offered by GitHub.

Get to Know Markdown & GitHub for Government

Not as necessary but very helpful when working with GitHub is how to write “Markdown.” Markdown uses regular alphanumeric characters to create text documents that have some formatting and is the preferred authoring method for GitHub documentation. It is quite easy to learn as this 10-minute tutorial demonstrates.

You can also check out the community of government technologists working in GitHub for Government; best practices for using open source in government; and a recap of the DigitalGov University webinar on GitHub that will walk you through various scenarios, like pull requests and issue creation.

Agency Developers looking to jump-start their efforts can also find source code for native and web projects in the Mobile Code Sharing Catalog, which contains code from a variety of sources: federal agencies, other governments, and third-parties in the private sector .

OpenFDA is an exciting project in federal government APIs because of the richness of the data and possibilities it offers for creating amazing applications. The documentation is very well-done both on the OpenFDA website and in GitHub. If you want to develop your skills in using GitHub, OpenFDA’s GitHub repository is an excellent training resource.Each week in “The API Briefing,” I will showcase government APIs and the latest API news and trends. Visit this blog every week to learn how government APIs are transforming government and improving government services for the American people. If you have ideas for a topic or have questions about APIs, please contact me via email. Dr. William A. Brantley, PMP, is a Program Analyst, in Forecasting and Methods at the U.S. Office of Personnel Management (OPM). You can find out more about his work in this space at BillBrantley.com.

Tags: , , , , , ,

File name

2014-06-11-the-api-briefing-quick-guide-to-using-github-fdas-openfda-research-project.md

File path

posts/2014/06/2014-06-11-the-api-briefing-quick-guide-to-using-github-fdas-openfda-research-project.md

Link Shortcode

{{< link "posts/2014/06/2014-06-11-the-api-briefing-quick-guide-to-using-github-fdas-openfda-research-project.md" >}}

Top