Workshop -- agenda, slides, activities

An authorization method for API requests that uses a third-party identity server such as Google, GitHub, or Facebook.

A tool you can use to submit API requests directly from the command line.

A GUI tool that lets you save and organize API requests into collections.

A format that includes both objects and arrays, and often a mix of both.

A space-sensitive format that is commonly used to write the OpenAPI specification.

The four most common methods or operations used with API requests.

The five common sections every API reference topic usually has.

A description of all possible elements in a response, including their data types and other details.

The object within the OpenAPI specification that lets you store re-usable content that can be referenced in other parts of the specification document using $ref.

The original name of the OpenAPI specification.

An authoring and validation tool useful when creating OpenAPI specification files.

A design model where you create the OpenAPI specification first before beginning any coding.

Information about request thresholds and what happens when you exceed them.

An open-source web framework that renders OpenAPI specification documents into an interactive documentation experience.

Authoring and publishing tools/workflows that follow similar patterns as software development tools and workflows.

A request to merge a branch back into the master; this workflow is often used when merging contributions back in to GitHub projects.

The tendency for docs maintained outside of code repositories to become out of sync with the code.

An essential first steps document for users that should usually be linked from your product overview page.

The go-to place to find open-source projects and collaborate with others on code projects.

A number shown in an API response when a request either succeeds or fails.

A parameter that appears in the resource URL after a question mark.

A string often included in a header or query string parameter that authorizes the API request.

The premium version of Swagger Editor.

A GUI tool for designing OpenAPI specification files, including the ability to auto-generate the schema description for JSON.

Programmatically building documentation from the server when you commit to a particular Git branch.

A web service API format, based on XML, that was popular before REST took over the landscape.

A type of API that consists of libraries or other code that you download and incorporate directly into your project.

Tooling that supports the implemention of an API in a specific programming language.

A parameter that appears directly in the resource URL (before any query strings).