Apia OpenAPI Specification

This gem can generate an OpenAPI compatible schema from an API implemented using Apia.

This gem is in the early phases of development and breaking changes may be introduced whilst the gem is in the 0.1.x version range.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add apia-open_api

Usage

The schema can be mounted in much the same way as an Apia API itself.

For example, for a Ruby on Rails application:

module MyApp
  class Application < Rails::Application

    config.middleware.use Apia::OpenApi::Rack,
                          api_class: "CoreAPI::Base",
                          schema_path: "/core/v1/schema/openapi.json",
                          base_url: "http://katapult-api.localhost/core/v1"

  end
end

Where CoreAPI::Base is the name of the API class that inherits from Apia::API.

Generating a client library from the spec

It's possible to generate a client library from the generated OpenAPI schema using OpenAPI Generator.

For example we can generate a Ruby client with the following:

brew install openapi-generator
openapi-generator generate -i openapi.json -g ruby -o openapi-client --additional-properties=gemName=myapp-openapi-client,moduleName=MyAppOpenAPIClient

The generated client will be in the openapi-client directory and will contain a readme with instructions on how to use it.

Development

After checking out the repo, run bin/setup to install dependencies.

In /examples there is an example Apia API application that can be used to try out the gem.

Run rackup from the root of /examples to start the rack app running the example API. To view the generated OpenAPI schema, visit: http://127.0.0.1:9292/core/v1/schema/openapi.json /examples/config.ru shows how to mount the schema endpoint.

The generated schema can be viewed, validated and tried out using the online Swagger Editor. You'll need to add the bearer token to the swagger editor to authenticate the requests. After that, they should work as expected. The bearer token is defined in main_authenticator.rb.

Currently the online swagger-editor only allows the OpenAPI schema v3.0.0. But it's also possible to run the swagger-editor locally, which allows us to check against v3.1.0.

e.g with this docker-compose.yml file:

version: "3.3"
services:
  swagger-editor:
    image: swaggerapi/swagger-editor:next-v5
    container_name: "swagger-editor"
    ports:
      - "8081:80"

Run docker-compose up and visit http://localhost:8081 to view the swagger editor.

Tests and Linting

bin/rspec
bin/rubocop

You can also run bin/console for an interactive prompt that will allow you to experiment.

Releasing a new version

Release Please is configured. The convential commits format should be used and upon merging to main, Release Please will open a new PR following semver rules. When that Release Please PR is merged, a new version will be published to RubyGems.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/apiaframework/apia-open_api.

License

The gem is available as open source under the terms of the MIT License.

apiaframework / apia-openapi

readme