https://github.com/bump-sh-examples/rails-design-first

Speed up your Rails API development with OpenAPI request validation and contract testing.
https://github.com/bump-sh-examples/rails-design-first

api-documentation api-rest openapi openapi3 openapi31 rails sample

Last synced: 16 days ago
JSON representation

Speed up your Rails API development with OpenAPI request validation and contract testing.

• Host: GitHub
• URL: https://github.com/bump-sh-examples/rails-design-first
• Owner: bump-sh-examples
• License: other
• Created: 2024-01-07T14:36:56.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-11T16:05:34.000Z (11 months ago)
• Last Synced: 2024-11-20T18:43:25.870Z (3 months ago)
• Topics: api-documentation, api-rest, openapi, openapi3, openapi31, rails, sample
• Language: Ruby
• Homepage: https://bump.sh/bump-examples/hub/code-samples/doc/rails-design-first
• Size: 62.5 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_CC-BY-NC-SA-4.0

Awesome Lists containing this project

README

        
# Rails Hello OpenAPI

This repository was built as sample code for the Bump.sh guide on _[Using OpenAPI to simplify building and testing Ruby on Rails APIs](https://docs.bump.sh/guides/openapi/design-first-rails/)_. Learn to use the API Design First workflow, and simplify your Rails code by not having to repeat your API contract in validation and contract testing as well as documentation. Just do it once, make easy code, then pop it all onto Bump.sh to have [great API documentation](https://bump.sh/bump-examples/hub/code-samples/doc/rails-design-first).

## Usage

Clone the repository down to give it a try.

```

# Set everything up

$ bundle install

# Start the server

$ rails s

# Poke the API and get automated  errors

$ curl -X POST http://localhost:3000/widgets -H "Content-Type: application/json" -d '{}'  | jq .

{

  "title": "Bad Request Body",

  "status": 400,

  "errors": [

    {

      "message": "object at root is missing required properties: name",

      "pointer": "",

      "code": "required"

    }

  ]

}

```

Give it a try, play around with the OpenAPI, and see how it responds to different scenarios. 

Then you can run `rspec` to see if the API responses match what OpenAPI expect, which when implemented in your application will help make sure your API is actually doing what your docs are saying, or make sure your docs are saying what your API is doing, whichever way round you prefer to think of it.

Preview how the API reference docs look [on Bump.sh](https://bump.sh/bump-examples/hub/code-samples/doc/rails-design-first).

## License

The contents of this repository are licensed under [CC BY-NC-SA

  4.0](./LICENSE_CC-BY-NC-SA-4.0).