Documenting API reference topics
23/108 pages complete. Only 85 more pages to go...
Donate?
Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.
- Introduction to REST APIs
- Using a REST API as 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
- 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
- Documenting API reference topics
- A new endpoint to document
- API reference tutorial overview
- Step 1: Resource description (API ref tutorial)
- Step 2: Endpoints and methods (API ref tutorial)
- Step 3: Parameters (API ref tutorial)
- Step 4: Request example (API ref tutorial)
- Step 5: Response example and schema (API ref tutorial)
- Putting it all together
- Activity: Critique or create an API reference topic
- Testing your API documentation
- Documenting non-reference sections
- User guide topics
- API overview
- Getting started tutorial
- Authentication and authorization
- Status and error codes
- Rate limiting and thresholds
- Code samples and tutorials
- SDKs and sample apps
- Quick reference guide
- API best practices
- Glossary
- Activity: Assess the non-reference content in your project
- Next phase of course
- OpenAPI specification and Swagger
- Overview of REST API specification formats
- Introduction to the OpenAPI spec and Swagger
- Working in YAML
- OpenAPI tutorial overview
- Step 1: openapi object (OpenAPI tutorial)
- Step 2: info object (OpenAPI tutorial)
- Step 3: servers object (OpenAPI tutorial)
- Step 4: paths object (OpenAPI tutorial)
- Step 5: components object (OpenAPI tutorial)
- Step 6: security object (OpenAPI tutorial)
- Step 7: tags object (OpenAPI tutorial)
- Step 8: externaldocs object (OpenAPI tutorial)
- Activity: Create an OpenAPI specification document
- Swagger UI tutorial
- Swagger UI Demo
- SwaggerHub introduction and tutorial
- Stoplight — visual modeling tools for creating your spec
- Integrating Swagger UI with the rest of your docs
- Publishing your API documentation
- 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
- Publishing tool options for developer docs
- Which tool to choose for API docs — my recommendations
- Activity: Manage content in a GitHub wiki
- Activity: Use the GitHub Desktop Client
- Pull request workflows through GitHub
- Jekyll and CloudCannon continuous deployment
- Case study: Switching tools to docs-as-code
- Getting a Job in API Documentation
- Documenting native library APIs
- Glossary and resources
Sponsors
Search results
