commercetools/commercetools-api-reference

There is no license information available for the latest version (dev-master) of this package.

dev-master 2019-10-02 09:21 UTC

README

Commercetools Platform API reference documentation

⚠️ Please note that this project is currently in the ALPHA version and is subject to change.

Build Status

Postman

See postman documentation

Swagger

Please use the api.swagger.json

RAML API Console

Using RAML API Console 4

Building the API console image

docker build . -t api_console

Running the API Console image

docker run --rm -p8081:8081 api_console

Using RAML API Console 3

Building the API console image

docker build console -t api_console

Running the API Console image

docker run --rm -p9000:9000 -p35729:35729 -v$(pwd):/apis api_console

Running the static webserver only

docker run --rm -p9000:9000 -p35729:35729 -v$(pwd):/apis api_console grunt connect:livereload:keepalive

Development

run internal consistency test

npm install
node bin/explode-raml.js > consistency-validation-results.md

run converter to OAS format

npm install
node bin/oas-convert.js

update the RAML types definition

docker run --rm -v${PWD}:/app -w /app php:7.1-alpine php bin/types.php

run Postman collection generator

To generate the postman collection in ./postman/collection.json perform the following tasks:

docker pull vrapio/rmf-generator
docker run --rm -v"$PWD":/api -v"$PWD":/out vrapio/rmf-generator -l postman /api/postman.raml