Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shipengine/shipengine-openapi

The official OpenAPI 3.0 definitions for ShipEngine™
https://github.com/shipengine/shipengine-openapi

address-validation address-verification openapi openapi3 rest-api shipment-tracking shipping shipping-api shipping-label shipping-rates swagger

Last synced: 1 day ago
JSON representation

The official OpenAPI 3.0 definitions for ShipEngine™

Host: GitHub
URL: https://github.com/shipengine/shipengine-openapi
Owner: ShipEngine
Created: 2018-10-31T15:06:25.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-12-07T01:34:47.000Z (20 days ago)
Last Synced: 2024-12-25T07:07:24.765Z (1 day ago)
Topics: address-validation, address-verification, openapi, openapi3, rest-api, shipment-tracking, shipping, shipping-api, shipping-label, shipping-rates, swagger
Homepage: https://shipengine.github.io/shipengine-openapi/
Size: 5.64 MB
Stars: 24
Watchers: 22
Forks: 16
Open Issues: 12
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        ![OpenAPI Logo](https://shipengine.github.io/img/openapi-logo.png) ShipEngine™ OpenAPI Definition

==============================================

This repo contains the official [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) definitions for the [ShipEngine API](https://shipengine.com).  You can use these definitions with any of countless [OpenAPI tools](https://openapi.tools/) to generate sample code, tests, mock servers, etc.

Which file to use

-----------------------------------

Depending on your preferences and/or tooling, you may choose to use one or more of the following files:

|Path                |Description

|:-------------------|:--------------------------------

|[`openapi.yaml`](openapi.yaml)        |The entire ShipEngine OpenAPI definition, in a single YAML file.  This file uses [`$ref` pointers](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#reference-object) to reduce duplication and keep the file small and fairly human-readable.

 Some [OpenAPI tools](https://openapi.tools/) don't support YAML or don't support `$ref` pointers, so you may need to use the [`openapi.json` file](openapi.json) instead.

|[`openapi.json`](openapi.json)        |The entire ShipEngine OpenAPI definition, in a single JSON file.  This file **does not** contain any `$ref` pointers, which means it should work with any [OpenAPI tool](https://openapi.tools/).

Other API Definition Formats

----------------------------

### ![Redoc Logo](https://shipengine.github.io/img/redoc-logo-small.png)

View the ShipEngine API definition [online in your browser](https://shipengine.github.io/shipengine-openapi/). This web page is generated from the [OpenAPI definition](https://github.com/ShipEngine/shipengine-openapi) using [ReDoc](https://github.com/Redocly/redoc).

### ![Postman Logo](https://shipengine.github.io/img/postman-logo-small.png) Postman

The official [Postman reference collection](https://documenter.getpostman.com/view/305204/SW7W5V6o) for ShipEngine.  Just import it into [Postman](https://getpostman.com) and immediately begin interacting with the ShipEngine API. 

New to ShipEngine? Download our [walkthrough collection instead](https://documenter.getpostman.com/view/305204/SW7XbA6V).

### ![JSON Schema Logo](https://shipengine.github.io/img/json-schema-logo-small.png) JSON Schema

If you need to validate API requests and responses, then you may want to use [our JSON Schema definitions](https://github.com/ShipEngine/shipengine-json-schema).