OpenAPI specification guides and tutorials
Learn how to use OpenAPI to build HTTP APIs that humans and machines can interact with conveniently.
What is OpenAPI?
OpenAPI allows to describe, develop, test, and document APIs conforming to the REST architecture, to create RESTful APIs.
Creating an API with Express.js using OpenAPI
This tutorial walks you through the creation of a REST API in a Node.JS enviromnent, and its documentation using Bump.sh.
Using OpenAPI to simplify building and testing Ruby on Rails APIs
In a Design-first approach and RoR API, leverage OpenAPI to verify specific request responses or write a test suite for your complete API contracts.
Using OpenAPI to simplify building and testing Laravel APIs
Dive into the API Design-first workflow with Laravel PHP, leveraging OpenAPI to power your server-side request validations, and build a contracting test suite based off that same API contract.
Code-first: How to Generate OpenAPI from Code
Learn how to generate OpenAPI from an existing codebase.
Generating OpenAPI docs for Ruby on Rails with RSwag
This guide describes, in a code-first approach and RoR codebase, how to generate OpenAPI description documents, enhancing it with contextual information and deploying it to Bump.sh.
Generating OpenAPI docs for Laravel with Swagger-PHP
This guide describes, in a code-first approach and Laravel codebase, how to generate OpenAPI description documents, enhancing it with contextual information and deploying it to Bump.sh.
Building your API: Design Mode
Read a practical example of how to write your first OpenAPI contract, and publish it via Bump.sh.
OpenAPI & AsyncAPI $ref: Advanced Guide
Learn how to use $ref to reduce clutter and repetition in your OpenAPI and AsyncAPI documents.