search

apigitlabs / apigit-support

APIGIT is a native Git based collaboration platform for API design, document, mock and share.
https://apigit.com
1 stars 0 forks source link

Support to edit the components through UI forms #29

Closed jvahldick closed 6 months ago

jvahldick commented 6 months ago

Is there an existing request for this feature?

Is your feature request related to a problem?

Editing the API specification through UI is a great time-saver, and I believe this feature should also be expanded to the components. Nowadays, when editing a specification, there are a couple of options: Info, Tags, Servers, Security, Paths, Webhooks, Schema, Parameter

Ideally, it would be great if the client could define what components should be visible/edited through UI.

For example, responses, headers, and request bodies are beneficial, and it would be handy to edit through UI to not overload the "Schema" node. https://swagger.io/docs/specification/components/#structure

Describe the solution you'd like

Option 1: IMO, that's the best option.

Having a section where the client can add/remove components and define their schema. That would be displayed as a standalone element in the menu when editing the schema through UI.

Option 2: Have some pre-defined components, as it is in Stoplight. In Stoplight, there is also a specific section to manage the components, and you can create folders, etc, to manage them more efficiently.

Please see the images:

Screenshot 2024-02-23 at 12 48 25 Screenshot 2024-02-23 at 13 12 34

The image on the left is the APIGit, which has new components (in green) that the client could edit. The image on the right side is the specific section of components. Then, when editing the schema through the form, we can refer it to some component node whenever we select an object.

Describe alternatives you've considered

No response

Additional context

No response

apigitlabs commented 6 months ago

thanks @jvahldick , we have another customer submit similar request a while ago. we are will have a new deployment to address it this week

apigitlabs commented 6 months ago

hi @jvahldick , we just get it supported to edit or reference components like requestBody, response, schema and parameters. please have a try and let us know if you have further questions.