Qodex.ai

Introduction to Documentation

Number of APIs: 8

Quick Start

  1. Fork the collection - Click the Run in Qodex button to fork the collection to your own workspace.
  2. Select the first folder - Begin with the first folder labeled Book API Reference, and expand the documentation from the context bar on the right.

Qodex: An Introduction for Developers

aired October 6, 2021

View the slides here.

API Publishers Series, Part 1: Introduction to Documentation

View the slides here.

At the end of this session, you'll walk away with all the basic skills you need to get started with Qodex.
✅ Explain the influence of documentation on user onboarding

✅ Develop a checklist for good documentation

✅ Generate documentation from OpenAPI specification

✅ Build sample workflows/guides for easier onboarding

✅ Publish a public workspace for community collaboration

✅ Share documentation in the Qodex API Network

Join the the Qodex Intergalactic Series!

Qodex Intergalactic is a a series of educational sessions. Each lesson is taught by your favorite Qodexauts. [Sign up to be notified about upcoming sessions]

Additional Resources

Feeling stuck or want to dig deeper into specific topics? We've got you covered:

* [Generating API Documentation] - This Learning Center resource covers generating documentation for a specific version of the API.
* [Blog post: The Good Documentation Checklist] - A blog post walking you through the traits of good documentation in Qodex
* Blog post: The Ultimate API Publisher's Guide - A blog post that let’s you review some best practices for documenting your API.
* [Blog post: Introducing the All-New Run in Qodex Button] - This blog post resource walks through the Run in Qodex button - a way to consume public APIs faster.

Generate the collection from an OpenAPI

The collection was generated from the OpenAPI specification here. More information about generating documentation from a schema is available [here] You can learn more about the API here.

How to generate the API Key?

* Sign up for an account on https://developer.nytimes.com/accounts/create
* Once you log in, you can create an app and enable the Books API
* Copy the API key generated, go over to the Collection variables and set that as current value for apiKey variable.

  1. Books API Reference-lists - Best Seller List Names GET {{baseUrl}}/lists/names.{{format}}

  2. Books API Reference-lists - Best Seller History List GET {{baseUrl}}/lists/best-sellers/history.json

  3. Books API Reference-lists - Best Seller List Overview GET {{baseUrl}}/lists/overview.{{format}}

  4. Books API Reference-lists - Best Seller List by Date GET {{baseUrl}}/lists/:date/{{list}}.json

  5. Books API Reference - Best Seller List GET {{baseUrl}}/lists.{{format}}

  6. Books API Reference - Reviews GET {{baseUrl}}/reviews.{{format}}

  7. Get Top 1 Author's Book Reviews (Hardcover Fiction) - Best Seller List GET {{baseUrl}}/lists.{{format}}?list=hardcover-fiction

  8. Get Top 1 Author's Book Reviews (Hardcover Fiction) - Reviews GET {{baseUrl}}/reviews.{{format}}?author={{author}}