Commit 926e96d7 authored by Rich Gerdes's avatar Rich Gerdes

Update README.md

parent 88bfc3aa
......@@ -3,3 +3,28 @@
**Open** **J**son **A**pi **C**lient is a JavaScript library for REST API
discovery and connectivity using the [{json:api}](http://jsonapi.org/) and the
[Open Api](https://www.openapis.org/) (A.K.A. Swagger) specifications.
## About
OpenJAC is designed to support any api that complies with the JsonApi standard.
The current build adheres to v1.0 of the JsonApi standard. The basic api can be
initialized using supplied definitions or though an OpenAPI complaint api
specification. OpenAPI standards must comply with version 2.0 of the OpenAPI
standard.
## Additional Details
For OpenJAC to properly discover an API based on OpenAPI 2.0 specifications,
the API must provide additional mapping to allow linking of API paths to the
definition types. If the API does not provide this logic, the user will need to
provide the necessary code to complete the mapping.
*@TODO: Additional details required to extra api meta data.*
## Roadmap
The following tasks are planned as part of this project. Contributions or
assistance with these tasks is welcome.
1. Support for OpenAPI v3.0.*
2. Support for JsonAPI v1.1
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment