Skip to content
Snippets Groups Projects
Commit 153cf149 authored by Rich Gerdes's avatar Rich Gerdes Committed by Rich Gerdes
Browse files

Issue #2985596 by richgerdes: Readme suggests an invalid demo URL

parent 2fcdc85c
No related branches found
No related tags found
No related merge requests found
......@@ -22,7 +22,31 @@ sub module's README.md.
## Documentation
The Open API specification document in JSON format that describes all of the
entity REST resources can be downloaded from, `openapi/entities?_format=json`.
### What is OpenAPI?
Openapi is a standard for documenting api functionality.
[Learn more about Open API](https://github.com/OAI/OpenAPI-Specification).
### Using OpenAPI
In order to view the schema documents you will need to have a supported module
enabled in your site. The module provides support for the REST module, found in
Drupal Core, and the contributed [JsonAPI module](https://www.drupal.org/project/jsonapi).
Once a supported module is installed, you can navigate to the schema url to
view the entity schema. For the two supplied modules, these urls are below.
- REST - /openapi/rest?_format=json
- JsonAPI - /openapi/json?_format=json
If you don't have one of these modules enabled, you will need to do so in order
to use the functionality provided by this module.
### Adding support for a custom api
You can write additional integrations for other rest modules and contributed
functionality. OpenAPI leverages plugins to detect and generate the download
documents. Please take a look a the source for the jsonapi and rest module
integrations, which are found in this module. For support and assistance with
custom integrations, please open a support request issue for the OpenAPI module
on Drupal.org.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment