We can't find the internet
Attempting to reconnect
Something went wrong!
Hang in there while we get back on track
Improve your API and OpenAPI - Rob Allen - PHP UK 2022
Improve your API and OpenAPI with a machine-readable and easy-to-update specification. Learn how to write, edit, and validate your API using YAML and get started with building a developer portal.
- Define API specification in an open format, like YAML, to make it machine-readable and easy to update.
- Use an editor that supports plugins, like VS Code, to write and edit the specification.
- The open API spec is not a standard programming language, but a contract that defines how an API should be implemented.
- Use a validator to check if the API request is valid, and return an error if it’s not.
- Create a developer portal using the API specification, and use it to generate documentation.
- The open API specification defines a standard structure for API request and response bodies, and allows for machine-readable validation.
- Using an API specification can increase adoption and reduce errors.
- Tooling is available to support the open API specification, such as Prism, which can read and validate the YAML file.
- The open API specification is an open standard, and is supported by many companies, including Vonage.
- An API specification can be used to describe the API before it is implemented, and to generate documentation.
- A developer portal can be used to provide a consistent interface for integrators.
- Using a consistent API description can increase adoption and reduce errors.