Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (29 sloc) 1.56 KB

API Elements

API Elements is a structure for describing APIs and the complex data structures used within them. It also provides structures for defining parsing results for parsing API definitions from formats like API Blueprint and Swagger/OpenAPI Format.

Getting Started

To start learning about and using API Elements, please check out the overview, which includes explanations and examples. If you are interested in finding libraries and tools for building and consuming API Elements, you will find this information on the tools page.

Contributing

Feel free report problems or propose new ideas using the API Elements GitHub issues. We are always interested in Pull Requests as well for changes.

About this Documentation

This documentation conforms to RFC 2119, which says:

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

MSON is used throughout this document to define elements and structures.

Contents

.. toctree::
   :maxdepth: 1

   overview
   element-definitions
   examples
   tools
   additional-information
   extensions/index
   migration

License

MIT License. See the LICENSE file.