https://github.com/bump-sh-examples/laravel-code-first

Add OpenAPI powered documentation to your Laravel application with Swagger-PHP.
https://github.com/bump-sh-examples/laravel-code-first

api api-code-first api-documentation api-documentation-tool api-rest code-first laravel laravel-framework laravel10 oas3 openapi swagger

Last synced: 7 days ago
JSON representation

Add OpenAPI powered documentation to your Laravel application with Swagger-PHP.

• Host: GitHub
• URL: https://github.com/bump-sh-examples/laravel-code-first
• Owner: bump-sh-examples
• License: other
• Created: 2024-01-19T16:27:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-11T16:05:14.000Z (11 months ago)
• Last Synced: 2024-11-20T18:43:27.429Z (2 months ago)
• Topics: api, api-code-first, api-documentation, api-documentation-tool, api-rest, code-first, laravel, laravel-framework, laravel10, oas3, openapi, swagger
• Language: PHP
• Homepage:
• Size: 101 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_CC-BY-NC-SA-4.0

Awesome Lists containing this project

README

        
# Laravel Code First

A quick "Hello World" Laravel application, but for generating OpenAPI, using the Laravel extension [Swagger-PHP](https://zircote.github.io/swagger-php/).

This repository was built as sample code for the Bump.sh guide on [Generating OpenAPI docs for Laravel with Swagger-PHP](https://docs.bump.sh/guides/openapi/code-first-laravel/).

## Usage

Clone the repository down to give it a try.

```

# Set everything up

$ composer install

# Export the OpenAPI

$ ./vendor/bin/openapi app -o openapi.yaml

# Take a look at the generated OpenAPI

cat openapi.yaml

```

Preview how the API reference docs look [on Bump.sh](https://bump.sh/bump-examples/hub/code-samples/doc/laravel-code-first).

## License

The contents of this repository are licensed under [CC BY-NC-SA

  4.0](./LICENSE_CC-BY-NC-SA-4.0).