Table of Contents
I need your input — I'm conducting a survey about trends in developer documentation for 2020. If you write docs for developers, please take this survey. (You can view the ongoing results viewed here.)
- I: Introduction to REST APIs
- Course Overview
- Workshop video recordings
- Workshop agenda, slides, activities
- Why I developed this course
- About the author
- Introduction to REST API documentation
- What is a REST API?
- Activity: Identify your goals
- II: Using an API like a developer
- Scenario for using a weather API
- Get authorization keys
- Submit requests through Postman
- curl intro and installation
- Make a curl call
- Understand curl more
- Activity: Use methods with curl
- Analyze the JSON response
- Inspect the JSON from the response payload
- Access and print a specific JSON value
- Dive into dot notation
- III: Documenting API endpoints
- A new endpoint to document
- API reference tutorial overview
- Step 1: Resource description
- Step 2: Endpoints and methods
- Step 3: Parameters
- Step 4: Request example
- Step 5: Response example and schema
- Putting it all together
- Activity: What's wrong with this API reference topic
- Activity: Evaluate API reference docs for core elements
- IV: OpenAPI spec and Swagger
- Overview of REST API specification formats
- Introduction to the OpenAPI spec and Swagger
- Fastest Way to Create an OpenAPI Specification Document
- Working in YAML
- OpenAPI tutorial overview
- Step 1: The openapi object
- Step 2: The info object
- Step 3: The servers object
- Step 4: The paths object
- Step 5: The components object
- Step 6: security object
- Step 7: The tags object
- Step 8: The externalDocs object
- Activity: Create an OpenAPI specification document
- Swagger UI tutorial
- Swagger UI Demo
- Stoplight — visual modeling tools for creating your spec
- SwaggerHub introduction and tutorial
- Integrating Swagger UI with the rest of your docs
- Create a display using Redoc
- V: Testing API docs
- Overview of testing your docs
- Set up a test environment
- Test all instructions yourself
- Test your assumptions
- Activity: Test your project's documentation
- VI: Conceptual topics in API docs
- API conceptual topics overview
- API overview
- API getting started
- API authentication and authorization
- API status and error codes
- API rate limiting and thresholds
- API quick reference
- API glossary
- API best practices
- Activity: Complete the SendGrid Getting Started tutorial
- Activity: Assess the conceptual content in your project
- VII: Code tutorials
- Common characteristics of code tutorials
- Why documenting code is so difficult
- What research tells us about documenting code
- Five strategies for documenting code
- API code samples
- SDKs (software development kits)
- Giving feedback on API design and usability
- VIII: Publishing API docs
- Overview for publishing API docs
- List of 100 API doc sites
- Design patterns with API doc sites
- Docs-as-code tools
- More about Markdown
- Version control systems (e.g., Git)
- Following agile scrum with documentation projects
- Activity: Manage content in a GitHub wiki
- Activity: Use the GitHub Desktop Client
- Activity: Pull request workflows through GitHub
- Static site generators
- Hosting and deployment options
- Which tool to choose for API docs — my recommendations
- Jekyll and CloudCannon continuous deployment tutorial
- Case study: Switching tools to docs-as-code
- IX: Thriving in the API doc space
- The job market for API technical writers
- How much code do you need to know?
- Best locations for API documentation jobs
- Activity: Find an Open Source Project
- Activity: Create or fix an API reference documentation topic
- X: Native library APIs
- Overview of native library APIs
- Get the sample Java project
- Java crash course
- Activity: Generate a Javadoc from a sample project
- Javadoc tags
- Explore the Javadoc output
- Make edits to Javadoc tags
- Doxygen, a document generator mainly for C++
- Create non-ref docs with native library APIs
- XI: API glossary and resources
- Glossary for API documentation
- REST API activities
- Activity: Get event information using the Eventbrite API
- Activity: Retrieve a gallery using the Flickr API
- Activity: Get wind speed using the Aeris Weather API
- RAML tutorial
- API Blueprint tutorial
- API jeopardy answer key
- What's wrong with this topic answer key
- Menlo Park API workshop video recording
- Denver API workshop video recording
- API doc presentation video recordings