openapi3: OpenAPI 3.0 data model

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

This library is intended to be used for decoding and encoding OpenAPI 3.0 API specifications as well as manipulating them.

The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.


[Skip to Readme]

Properties

Versions 3.0.0, 3.0.0.1, 3.0.1.0, 3.0.1.0, 3.0.2.0, 3.1.0, 3.2.0, 3.2.1, 3.2.2, 3.2.3, 3.2.4
Change log CHANGELOG.md
Dependencies aeson (>=1.4.2.0 && <1.6), aeson-pretty (>=0.8.7 && <0.9), base (>=4.11.1.0 && <4.15), base-compat-batteries (>=0.11.1 && <0.12), bytestring (>=0.10.8.2 && <0.11), containers (>=0.5.11.0 && <0.7), cookie (>=0.4.3 && <0.5), generics-sop (>=0.5.1.0 && <0.6), hashable (>=1.2.7.0 && <1.4), http-media (>=0.8.0.0 && <0.9), insert-ordered-containers (>=0.2.3 && <0.3), lens (>=4.16.1 && <4.20), mtl (>=2.2.2 && <2.3), network (>=2.6.3.5 && <3.2), openapi3, optics-core (>=0.2 && <0.4), optics-th (>=0.2 && <0.4), QuickCheck (>=2.10.1 && <2.15), scientific (>=0.3.6.2 && <0.4), template-haskell (>=2.13.0.0 && <2.17), text (>=1.2.3.1 && <1.3), time (>=1.8.0.2 && <1.10), transformers (>=0.5.5.0 && <0.6), unordered-containers (>=0.2.9.0 && <0.3), uuid-types (>=1.0.3 && <1.1), vector (>=0.12.0.1 && <0.13) [details]
License BSD-3-Clause
Copyright (c) 2015-2016, GetShopTV, (c) 2020, Biocad
Author Nickolay Kudasov, Maxim Koltsov
Maintainer nickolay@getshoptv.com, kolmax94@gmail.com
Category Web, Swagger, OpenApi
Home page https://github.com/biocad/openapi3
Bug tracker https://github.com/biocad/openapi3/issues
Source repo head: git clone https://github.com/biocad/openapi3.git
Uploaded by maksbotan at 2020-12-11T09:12:42Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for openapi3-3.0.1.0

[back to package description]

OpenApi 3

Hackage Build Status Stackage LTS Stackage Nightly

OpenAPI 3.0 data model.

The original OpenAPI 3.0 specification is available at http://swagger.io/specification/.

This package is heavily based on excellent work on Swagger 2.0 at https://github.com/GetShopTV/swagger2.

Usage

This library is intended to be used for decoding and encoding OpenApi 3.0.3 specifications as well as manipulating them.

Please refer to haddock documentation.

Some examples can be found in examples/ directory.

Trying out

All generated swagger specifications can be interactively viewed on Swagger Editor.

Ready-to-use specification can be served as JSON and interactive API documentation can be displayed using Swagger UI.

Many Swagger tools, including server and client code generation for many languages, can be found on Swagger's Tools and Integrations page.

Contributing

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the github issue tracker.

GetShopTV Team

Biocad Team