OpenAPI 3.1

Use the spec

• Generate a client: feed /api/v1/openapi.json into openapi-typescript, openapi-generator, or Kiota.
• Mock the API: point Prism or Stoplight Studio at the spec for offline development.
• Render Swagger UI / Redoc:drop the URL into the Swagger UI CDN bundle, or use Redoc's standalone. (We don't bundle these ourselves to keep the static build small.)
• Validate: the spec is OpenAPI 3.1 (draft-2020-12 JSON Schema dialect).

Server

https://goodsacrossborders.com

Paths (27)

• /api/v1/items.json

  GETList all items

• /api/v1/items/{slug}.json

  GETFetch a single Item

  Parameters: slug*

• /api/v1/countries.json

  GETList all countries

• /api/v1/countries/{slug}.json

  GETFetch a single Country

  Parameters: slug*

• /api/v1/rules.json

  GETList all rules

• /api/v1/rules/{id}.json

  GETFetch a single Rule

  Parameters: id*

• /api/v1/carriers.json

  GETList all carriers

• /api/v1/carriers/{slug}.json

  GETFetch a single Carrier

  Parameters: slug*

• /api/v1/medications.json

  GETList all medications

• /api/v1/medications/{slug}.json

  GETFetch a single Medication

  Parameters: slug*

• /api/v1/incoterms.json

  GETList all incoterms

• /api/v1/incoterms/{slug}.json

  GETFetch a single Incoterm

  Parameters: slug*

• /api/v1/hs-chapters.json

  GETList all hs-chapters

• /api/v1/hs-chapters/{chapter}.json

  GETFetch a single HsChapter

  Parameters: chapter*

• /api/v1/hs-headings.json

  GETList all hs-headings

• /api/v1/hs-headings/{heading}.json

  GETFetch a single HsHeading

  Parameters: heading*

• /api/v1/guides.json

  GETList all guides

• /api/v1/guides/{slug}.json

  GETFetch a single Guide

  Parameters: slug*

• /api/v1/airports.json

  GETList all airports

• /api/v1/airports/{iata}.json

  GETFetch a single AirportProfile

  Parameters: iata*

• /api/v1/airlines.json

  GETList all airlines

• /api/v1/airlines/{slug}.json

  GETFetch a single AirlineCabinPolicy

  Parameters: slug*

• /api/v1/scenarios.json

  GETList all scenarios

• /api/v1/scenarios/{slug}.json

  GETFetch a single ScenarioGuide

  Parameters: slug*

• /api/v1/duty-rates.json

  GETList all duty-rates

• /api/v1/route-pairs.json

  GETList all route-pairs

• /api/v1/changelog.json

  GETList all changelog

Component schemas (15)

• Item
• Country
• Rule
• Carrier
• Medication
• Incoterm
• HsChapter
• HsHeading
• Guide
• AirportProfile
• AirlineCabinPolicy
• ScenarioGuide
• DutyRate
• RoutePair
• ChangelogEntry