DEXIS - Delivery Exchange Interface Specification

DEXIS is a specification defining a simple API which can be used between a customer and hauler firm to exchange data about delivery orders.

The api describes:

• Query and filter existing deliveries
• Upsert delivery orders

The API definition is located at spec/spec.yaml

---

View the API with Swagger Tools

Use

https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ElderByte-/delivery-service-api/master/spec/spec.yaml

or

cd [absolute-repo-path]
docker run -p 9090:8080 -e SWAGGER_JSON=/spec.yaml -v $(pwd)/spec/spec.yaml:/spec.yaml swaggerapi/swagger-ui

• Open Browser http://localhost:9090

---

Edit the API with Swagger Tools

Use

https://editor.swagger.io/?url=https://raw.githubusercontent.com/ElderByte-/delivery-service-api/master/spec/spec.yaml

or

cd [absolute-repo-path]
docker run -p 9091:8080 swaggerapi/swagger-editor

• Open Browser http://localhost:9091
• Choose delivery-service-api/spec/spec.yaml using File / Import file
• Edit the specification
• Export the specification and commit the replaced delivery-service-api/spec/spec.yaml file

---

OpenAPI Specification

• https://swagger.io/resources/open-api/
• https://swagger.io/specification/

---

This repository is maintained and the api is designed by