You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Allan 4bb30fadce
Added oneOf examples (#948)
2 weeks ago
.github/workflows Clean up invalid args (#922) 3 months ago
Examples Added oneOf examples (#948) 2 weeks ago
bin Add Generator class for OO use (#928) 1 month ago
docs Add Generator class for OO use (#928) 1 month ago
src Add the operation path to the generated operation ID (#946) 2 weeks ago
tests Add the operation path to the generated operation ID (#946) 2 weeks ago
.gitignore doc: Updated vuepress to use local version 10 months ago
.php_cs.dist Switch `concat_space` to default (no space) 11 months ago
Changelog.md Document the changelog on the github releases page 3 years ago
LICENSE-2.0.txt Started the rewrite which will be compatible with Swagger v2.0 Spec 7 years ago
README.md Add Generator class for OO use (#928) 1 month ago
composer.json Document validation of generated Example specs (#898) 6 months ago
phpunit.xml.dist Github action CI migration (#886) 6 months ago
psalm.xml Typehint and phpdoc improvements based on phpstan 10 months ago

README.md

Build Status
Total Downloads
License

swagger-php

Generate interactive OpenAPI documentation for your RESTful API using doctrine annotations.

For a full list of supported annotations, please have look at the OpenApi\Annotations namespace or the documentation website.

Features

  • Compatible with the OpenAPI 3.0 specification.
  • Extracts information from code & existing phpdoc annotations.
  • Command-line interface available.
  • Documentation site with a getting started guide.
  • Exceptional error reporting (with hints, context)

Installation (with Composer)

composer require zircote/swagger-php

For cli usage from anywhere install swagger-php globally and make sure to place the ~/.composer/vendor/bin directory in your PATH so the openapi executable can be located by your system.

composer global require zircote/swagger-php

Usage

Add annotations to your php files.

/**
 * @OA\Info(title="My First API", version="0.1")
 */

/**
 * @OA\Get(
 *     path="/api/resource.json",
 *     @OA\Response(response="200", description="An example resource")
 * )
 */

Visit the Documentation website for the Getting started guide or look at the Examples directory for more examples.

Usage from php

Generate always-up-to-date documentation.

<?php
require("vendor/autoload.php");
$openapi = \OpenApi\Generator::scan(['/path/to/project']);
header('Content-Type: application/x-yaml');
echo $openapi->toYaml();

Documentation of how to use the Generator class can be found in the Generator Migration guide.

Usage from the Command Line Interface

The openapi command line interface can be used to generate the documentation to a static yaml/json file.

./vendor/bin/openapi --help

Usage from the Deserializer

Generate the OpenApi annotation object from a json string, which makes it easier to manipulate objects programmatically.

<?php

use OpenApi\Serializer;

$serializer = new Serializer();
$openapi = $serializer->deserialize($jsonString, 'OpenApi\Annotations\OpenApi');
echo $openapi->toJson();

Usage from docker

Generate the swagger documentation to a static json file.

docker run -v "$PWD":/app -it tico/swagger-php --help

More on OpenApi & Swagger

Contributing

Feel free to submit Github Issues
or pull requests.

The documentation website is build from the docs folder with vuepress.

Make sure pull requests pass PHPUnit
and PHP-CS-Fixer (PSR-2) tests.

To run both unit tests and linting execute:

composer test

Running unit tests only:

./bin/phpunit

Running linting only:

composer lint

To make php-cs-fixer fix linting errors:

composer cs