avency/neos-openapi

Last activity 11 Dec 2019 3 1 950
composer require avency/neos-openapi

OpenApi Basic package with swagger ui rendering

1.0.0

Homepage
https://github.com/avency/Avency.Neos.OpenApi
Version
1.0.0
Type
neos-package
Release Date
Dec 11, 2019 12:54
Source
git
Distribution
zip
Requires
  • neos/neos: ^4.0 || ^5.0 || dev-master
  • avency/swagger-php: 3.0.3
MIT
  • #flow
  • #documentation
  • #rest
  • #api
  • #neos
  • #swagger
  • #restapi
  • #openapi
  • #swagger ui
a65e1e36a9afcf28a94af111cffdcffd2125ab7c

Readme excerpt

Avency Neos OpenAPI

This package contains basics to generate an interactive OpenAPI documentation for a RESTful API using doctrine annotations.

It contains a controller that renders a swagger ui and which gets its input from a json-file generated based on the OpenAPI annotations in the projects' files.

It uses the sintbert/swagger-php package.

Calling the documentation Backend

There is a backend module accessible as administrator, which renders the swagger UI.

Frontend

To call the documentation in the frontend, you need to be logged in in the backend as administrator. Then you can call the api:

{PROJECT_BASE_URI}/neos/api/documentation.html

To access …
Read more

The content of the readme is provided by an external source, which we have no control over. Check out the actual readme at its source.
The same vendor provides 4 package(s).