Install
Works with Drupal: 8.xUsing Composer to manage Drupal site dependencies
Alternative installation files
Download tar.gz
28.71 KB
MD5: 44dd29fc276eb3f6554122567f1a4b47
SHA-1: 4dd6771ae297e404950bda051c45173c456a561f
SHA-256: 317e710f81a17b625b0dc5299bcbc4b7b7001119fe3ee52c53426200c24e5da1
Download zip
54.01 KB
MD5: c8feb45e96ad51edb329ea92c2fda5ee
SHA-1: 56e917a9cab82571774b731f1ebc0b798b9e438c
SHA-256: c2cca590f14c979090506b8b31b861c3070ca36763b19084fb1cf6c2864dc34e
Release notes
GitHub milestone: 8.x-1.0-beta1
Changelog:
- Add SmartDocs to API Catalog module: Open API specs is now formatted by the Apigee SmartDocs formatter by default.
- Add revisions to API Docs: Revsions are created by default for all changes to API Doc entities. This can be changed in administrator settings.
- Add url as source for apidocs spec file and allow re-fetching it when URL changes: OpenAPI specs can be uploaded as a file, or alternatively fetched via URL. If you fetch via URL, you can update the documentation if the file at that URL changes.
- Prevent installation alongside of apigee_edge_apidocs Apigee Edge submodule: The module started out as an Apigee Edge submodule named "API Docs". Since this module can conflict with the "API Docs" module. When enabling this module, an error will be shown if the API Docs module is already enabled.
- Remove API Product field: The API Product field on the API Docs entity is now hidden until the role based access control feature is added to this module.
Known Issues
- The Apigee SmartDocs formatter can only render one OpenAPI spec per page and the URL pattern must match
/api/{entityId}. This means that the formatter will probably not work correctly if you modify the default API Docs view or try to use this file formatter on nodes or other entities.
Providing feedback
To provide feedback and report issues, use the GitHub issue management tools. See Managing your work with issues in the GitHub documentation.
The GitHub repo for the Apigee Edge Drupal module is https://github.com/apigee/apigee-edge-drupal.