Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openapi
Manage
Activity
Members
Labels
Plan
Wiki
Custom issue tracker
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
project
openapi
Commits
153cf149
Commit
153cf149
authored
6 years ago
by
Rich Gerdes
Committed by
Rich Gerdes
6 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Issue
#2985596
by richgerdes: Readme suggests an invalid demo URL
parent
2fcdc85c
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+26
-2
26 additions, 2 deletions
README.md
with
26 additions
and
2 deletions
README.md
+
26
−
2
View file @
153cf149
...
...
@@ -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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment