jbrooksuk / chirper

Example application that demonstrates how to document Laravel APIs using Scribe.

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.

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