Get support for EXSyst/ApiDocBundle
If you're new to LTH, please see our FAQ for more information on what it is we do.
Support Options
Unfortunately, there are currently no active helpers for this repository on the platform. Until they become available, we reccomend the following actions:
View Open IssuesTake a look to see if anyone else has experienced the same issue as you and if they managed to solve it.
Open an IssueMake sure to read any relevant guidelines for opening issues on this repo before posting a new issue.
Sponsor directlyCheck out the page and see if there are any options to sponsor this project or it's developers directly.
EXSyst/ApiDocBundle
ApiDocBundle
[WIP] Generates Swagger docs from several sources
Installation
Just like any bundle, you have to download it using composer:
composer require exsyst/api-doc-bundle dev-master
And then add it to your kernel:
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = [
// ...
new EXSyst\Bundle\ApiDocBundle\ApiDocBundle(),
];
// ...
}
}
And that's all, no configuration needed!
What does this bundle?
It generates you a swagger documentation from your symfony app thanks to different sources called Describers. These Describers are specific to a library and extract data from it and merge it into your swagger documentation.
You can fetch your swagger documentation in your app:
$generator = $container->get('exsyst_api_doc.generator');
$swagger = $generator->generate()->toArray();
What's supported?
This bundle supports Symfony route requirements, PHP annotations, Swagger-Php annotations, NelmioApiDocBundle annotation, FOSRestBundle annotations and Api-Platform apps.
This bundle is a Work In Progress and as such it does only support input documentation for now (if you use Swagger-Php or Api-Platform output is supported as well).
What's next?
The hardest part remain: models. We have to build something to manage models that can vary based on several factors (serialization groups, class, etc.) and then put it in the app's documentation.
Other libraries support might be added but the priority is to finalize the bundle first.
Our Mission
We want to make open source more sustainable. The entire platform was born from this and everything we do is in aid of this.
From the Blog
Interesting Articles
-
Generating income from open source
Jun 23 • 8 min read
-
2023 State of OSS
Apr 23 • 45 min read ★
-
A funding experiment...
Aug 19 • 10 min read
-
But You Said I could
Aug 19 • 2 min read
Thank you for checking out LiveTechHelper |
2025 © lth-dev incorporated
p-e622a1a2