Skip to content

Commit

Permalink
Add features list to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yceruto committed Dec 21, 2023
1 parent 00f7f08 commit dcb9937
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ openapi:
resource: '@OpenApiBundle/config/routes.php'
```

## Features

- [x] Generate OpenAPI spec from PHP attributes
- [x] Expose Swagger UI to explore the OpenAPI spec and test API endpoints
- [x] Export OpenAPI spec in JSON and YAML format (via HTTP and console command)
- [x] Import OpenAPI spec in JSON and YAML format (via config file)
- [x] Define Symfony routes and OpenAPI Paths using the same attributes (`#[Post]`, `#[Get]`, `#[Put]`, `#[Patch]`, `#[Delete]`)
- [x] Conditional OpenAPI Path/Route definition (e.g. `#[Get('/me', when: 'service("me_feature").isEnabled()')]`)
- [x] Symfony attributes abbreviation (e.g. `#[Body]` instead of `#[MapRequestPayload]`, `#[Query]` instead of `#[MapQueryString]`, etc.)
- [x] Symfony's validation constraints definition using OpenAPI attributes (e.g. `#[Property(minLength: 3, maxLength: 255)]`)
- [x] Serialize controller response (JSON format by default)

## License

This software is published under the [MIT License](LICENSE)

0 comments on commit dcb9937

Please sign in to comment.