Aims at providing a complete more or less type safe mapping of OpenAPI specification. Currently supported version: 3.0.1. Use it to either write or parse OpenAPI specs.
Add this to your application's shard.yml
:
dependencies:
open_api:
github: jreinert/open_api.cr
require "open_api"
OpenAPI.build do |api|
doc = api.document(
openapi: "3.0.1"
info: {
title: "Catlib",
version: "0.1"
},
paths: {
"/meow" => api.path_item(
get: {
tags: ["cats"],
request_body: {
ref: "#/components/schemas/cat"
}
}
)
},
components: {
schemas: {
:cat => api.schema(
type: "object",
description: "A cat"
)
}
}
)
puts doc.to_json
)
require "open_api"
File.open("openapi.yml") do |file|
doc = OpenAPI.from_yaml(file)
puts doc.to_json
end
- Fork it (https://github.com/jreinert/open_api.cr/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
- jreinert Joakim Reinert - creator, maintainer