Kevin Uhlig’s API Documentation with Sphinx

This is my sandbox site on how I authored RESTful API non-reference and reference content in Sphinx. Utilize the Edit on GitHub link in top right corner of a page to see its Sphinx code.

Note: For the API reference section, I utilized Shippo API content.

API Non-Reference

• Overview
• Getting Started
  • Signing up for an account (Maybe)
  • Prerequisite Information / Before you Start (Maybe)
  • Get familiar with the App (Maybe)
  • Authentication and Authorization
  • What’s Included in an API Request
  • Example Request
  • Try out Request with Postman
  • Responses
  • Rate Limits
  • Examples of Getting Started
• Base Path
• Status and Error Codes
  • Examples

API Reference

• Addresses
  • The Address Object
  • POST Create a New Address
  • GET Retrieve an Address
  • GET Validate an Address
  • GET List All Addresses
• Parcels
  • The Parcels Object
  • Parcel Extras
  • POST Create a New Parcel
  • GET Retrieve a Parcel
  • GET List All Parcels
• Shipments
  • The Shipments Object
  • Shipment Extras
  • POST Create a New Shipment
  • GET Retrieve a Shipment
  • GET List All Shipments