DRAFT: 2.x renovation - multiple APIs #14
Conversation
rela589n
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
===========================================
+ Coverage 0 91.80% +91.80%
- Complexity 0 20 +20
===========================================
Files 0 2 +2
Lines 0 61 +61
===========================================
+ Hits 0 56 +56
- Misses 0 5 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| @@ -47,7 +47,7 @@ | |||
| "config": { | |||
| "sort-packages": true, | |||
| "allow-plugins": { | |||
| "symfony/flex": true | |||
| "symfony/flex": false | |||
There was a problem hiding this comment.
why have you disabled symfony flex?
There was a problem hiding this comment.
Since this is not an ultimate symfony project that needs recipes executed. Currently, running composer install executes all the recipes right in the SwaggerBundle's root. I don't think it should be the case, since it only brings the disturbing experience to anyone who would like to contribute.
| ``` | ||
|
|
||
| Imagine you have a Swagger spec like this: | ||
| Imagine you are to have a Swagger spec like this: |
There was a problem hiding this comment.
previous variant is correct. this one sounds wrong
There was a problem hiding this comment.
The meaning is slightly different. What is meant here could be rephrased in following way:
Imagine that you need to have following Swagger specification:
If it's ok with you, I'll use this description, if not - previous variant will be kept
| ```yaml | ||
| swagger: | ||
| config_folder: '%kernel.project_dir%/docs/api/' | ||
| apis: | ||
| frontend: |
There was a problem hiding this comment.
this should be an option if you have multiply api docs. but previous way should also be supported. because backwards compatibility will be broken.
so in the result it should support old and new implementation.
There was a problem hiding this comment.
Yes, you are 100% right that this is the BC break. Although, as for me, maintenance of the current config will be a real headache. Taking into account that migration to the new approach is really simple:
swagger:
- config_folder: '%kernel.project_dir%/docs/api/'
+ apis:
+ frontend:
+ config_folder: '%kernel.project_dir%/docs/api/'
+ doc_folder: '%kernel.project_dir%/public/api/'I would suggest releasing a new major version that breaks this compatibility and writing an UPGRADE guide to point out the desired changes.
In any case, if you wish, I could implement the feature w/o BC support and you could add this support afterwards, if needed.
Hi, @fre5h
I'm interested in upgrading this package by adding new features that large projects could need.
A first key enhancement current PR focuses on is providing multiple APIs tailored to the needs of various teams.
Some projects could necessitate more than just one frontend API. For example, there might be a demand for entirely separate API specifications for ERP or CRM teams, each with a unique set of endpoints and a distinct authentication system. Having a single api documentation for few parties exposes too much excessive details to them and brings unnecessary complexity.
As a result, it's practical to offer the capability to create fully independent API specifications designed for different people.
Currently I've updated
README.mdto show my vision on how this configuration could look like. Please, let me know what you think about it and whether can I proceed with the implementation?