$10 – $75

Event Information

Share this event

Date and Time

Location

Location

Metropolitan State University of Denver: Room CN113

1198 11th Street

Denver, CO 80204

View Map

Refund Policy

Refund Policy

Refunds up to 1 day before event

Event description

Description

API Documentation Workshop

REST APIs involve submitting requests and receiving responses, not too unlike visiting a web page. You make a request to a resource stored on a server, and the server responds with the requested information. HTTP is the medium for transporting the information. “REST” stands for representational state transfer.

In this workshop on documenting REST APIs, you’ll learn about API documentation in the context of using a simple weather API to put a weather forecast on your site. As you use the API, you’ll learn about curl, Postman, Chrome’s Developer Console, JSON, and other details associated with REST APIs.

After making requests to an API, we'll dive into each element of a reference topic in REST API documentation:


  • Resource descriptions
  • Endpoints and methods
  • Parameters
  • Request example
  • Response example and schema


We'll also explore how the OpenAPI specification (formerly called Swagger) can provide a standard for describing an API. The OpenAPI defines specific properties in a particular order and hierarchy covering each aspect of reference documentation, from endpoints to requests to security and responses. After you have a valid specification document, you can feed it into specific frameworks and platforms (such as Swagger UI, SwaggerHub, or Spectacle) to automatically generate interactive documentation.

We'll also dive into the non-reference sections in API documentation. These topics might include the following:


  • Getting started tutorial
  • Authentication
  • Status and error codes
  • How-to code tutorials
  • Sample apps and client SDKs


Finally, we’ll explore different ways to publish REST API documentation, looking at tools such as GitHub, Jekyll, and other docs-as-code approaches. You’ll learn how to choose the right source format, manage your content through version control, build from the server with continuous delivery, and more.

This workshop covers a broad range of topics, so the depth we go into with each area can vary based on the participants' questions and interests. My approach is to first learn what questions and information needs participants have and then give emphasis to those areas. Questions and discussion throughout will be welcome. We will do some hands-on activities during the workshop, but we won't get too detailed with technical activities, sticking more with high-level concepts and techniques.

About the presenter

Tom Johnson is a technical writer for Amazon in Sunnyvale, California. He writes a popular blog on technical writing called Idratherbewriting.com, where he explores topics such as API documentation, trends, information design, and more. He also has an extensive online course on API documentation (http://idratherbewriting.com/learnapidoc/) that includes extensive tutorials and other exercises you can follow to build your expertise with APIs, including the OpenAPI specification, Swagger, and more.

What are my transportation/parking options for getting to and from the event?

Far and away the easiest way to find the classroom is to take the light rail to the Auraria at Colfax stop. (This is only a few stops from the Broadway park and ride if you're coming from the south.) When you get off the light rail, you walk a few hundred yards into campus and the Central classroom building is on your right. It's the building with the covered walkway above the outdoor path.

If you don't take the light rail, then please make sure you download and look at the campus map before coming. Google maps directions will not take you to the correct building. There is a $4 charge for parking in any campus parking lot.

The nearest parking lot to the Central classroom is the Nutmeg lot [Google Map link], which is about a two minute walk from the classroom. From this lot, walk west, along St. Francis Way, towards the roundabout. From the roundabout, walk west on Champa street (away from Speer). The central classroom building has one door in the alley, facing East, and one on 10th street plaza, facing South.

The Tivoli parking garage is about a 10 minute, 1/2 mile walk from Central classroom. Directions from the garage to Central Classroom:

https://goo.gl/maps/WUh1GREuv5z

Walk South East (away from Auraria Parkway) along the 10th street plaza. Continue past the library, to Curtis street. If you reach Champa street, you have gone too far.

Share with friends

Date and Time

Location

Metropolitan State University of Denver: Room CN113

1198 11th Street

Denver, CO 80204

View Map

Refund Policy

Refunds up to 1 day before event

Save This Event

Event Saved