Skip to content
Snippets Groups Projects
Verified Commit cd90029e authored by Jonas Leder's avatar Jonas Leder
Browse files

formart Readme and add Download Links

parent e08d51e5
Branches
No related tags found
No related merge requests found
Pipeline #8456 passed
# Symfony API Documentation Generator # Symfony API Documentation Generator
This is a simple .NET CLI tool, which parses a JSON file and returns the annotations needed for the `NelmioApiDocBundle`. This is a simple .NET CLI tool, which parses a JSON file and returns the annotations needed for the `NelmioApiDocBundle`.
## Usage ## Usage
Open the Application from the CLI, then paste your JSON and press two times return. Now you get the Annotations matching your JSON. Please note values with null won't get any type. Open the Application from the CLI, then paste your JSON and press two times return. Now you get the Annotations matching your JSON. Please note values with null won't get any type.
## Downloads
* [Linux](https://gitlab.jonasled.de/jonasled/symfony-api-doc-generator/-/jobs/artifacts/master/download?job=build:linux)
* [Windows](https://gitlab.jonasled.de/jonasled/symfony-api-doc-generator/-/jobs/artifacts/master/download?job=build:windows)
* [MacOS (Intel only)](https://gitlab.jonasled.de/jonasled/symfony-api-doc-generator/-/jobs/artifacts/master/download?job=build:macos)
## Example ## Example
### Input ### Input
```json ```json
{ {
"id": 4051, "id": 4051,
...@@ -54,8 +64,10 @@ Open the Application from the CLI, then paste your JSON and press two times retu ...@@ -54,8 +64,10 @@ Open the Application from the CLI, then paste your JSON and press two times retu
] ]
} }
``` ```
### Output ### Output
```
```php
* @OA\JsonContent( * @OA\JsonContent(
* type="object", * type="object",
* @OA\Property( * @OA\Property(
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment