4 years ago

Category: Laravel, PHP, api

OpenAPI definitions are great to generate nice documentations, but there is much more we can do with them OpenAPI is a specification intended to describe RESTful APIs in JSON and YAML, with the aim of being understandable by humans and machines alike. OpenAPI definitions are language-agnostic and can be used in a lot of different ways: An OpenAPI definition can be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

A way to avoid this is to implement integration tests that will automatically check that the API’s behaviour is correct, and that recently introduced changes have not had unintended consequences.

To make sure Swagger PHP doesn’t overwrite the OpenAPI definition, let’s set the following environment variable in the .env file at the root of the project: Create a file named api-docs.yaml in the storage/api-docs folder (which you need to create), and add the following content to it: This is a simple OpenAPI definition describing a single operation — a GET request on the /api/test endpoint, that should return a JSON object containing a required foo key.