https://github.com/jbrooksuk/chirper
Example application that demonstrates how to document Laravel APIs using Scribe.
https://github.com/jbrooksuk/chirper
laravel openapi scribe
Last synced: 11 months ago
JSON representation
Example application that demonstrates how to document Laravel APIs using Scribe.
- Host: GitHub
- URL: https://github.com/jbrooksuk/chirper
- Owner: jbrooksuk
- Created: 2022-12-15T14:19:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T09:23:43.000Z (over 1 year ago)
- Last Synced: 2025-05-05T04:13:11.269Z (11 months ago)
- Topics: laravel, openapi, scribe
- Language: PHP
- Homepage: https://james.brooks.page
- Size: 342 KB
- Stars: 28
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chirper - Documenting Laravel APIs
This is the repository for the Chirper application that demonstrates how to document Laravel APIs using the OpenAPI specification with [Scribe](https://scribe.knuckles.wtf).
> [!NOTE]
> Checkout the `complete` branch for the completed documentation.
# Building The Documentation
Run the `./build.sh` script to generate the API documentation. This will generate the OpenAPI specification and static documentation in the `./public/docs` directory.
# Video
I have given this talk at a few conferences, some of which are recorded. I would recommend watching the video to get a better understanding of the concepts used.
- Laracon AU, 2023 - https://youtu.be/K-g-t99mKZU
- PHP UK, 2024 - https://youtu.be/aj7W__I5YXU