Skip to main content

Deploying docs from API Platform

API Platform is an API-first PHP framework that allows you to create REST and GraphQL APIs using PHP classes, and automatically generates their documentation, based on the OpenAPI specification. If you are new to API Platform, check out their getting started guide.

Deploying docs from your local machine

The following assumes your local machine is configured with PHP and API Platform.

  1. Create and name your first API documentation.

  2. Install the CLI with npm as below, or use alternative options, with

npm install -g bump-cli
  1. Launch your local server with Docker or Symfony

  2. Deploy your doc to with

bump deploy https://localhost/docs.json --doc my-documentation

That's it! Enjoy the comfort of to browse through your API doc, and customize it to your needs.