generating and updating open api from code

Question

I'm a technical writer documenting my first API.

Every time the API is updated, our developer generates an Open API using C# and I upload it to Stoplight and add descriptions.

The issue is that I want to create references for all the parameters ($ref), but the file that the developer outputs from the code does not reference parameters, it repeats the full description of each parameter each time it is used in an endpoint.

If I use updated file for the documentation, it will overwrite the references.

Is there a tool to generate the Open API from the code that will create and preserve referenced parameters?

ponelat · Answer

Hi&nbsp;osher&nbsp;
I'm not sure what code library your team uses (in C#) to generate the definition. Could you perhaps find out, and perhaps there are some options in that to help your problem of inlined-parameters.&nbsp;
&nbsp;
We know such options exist for languages like Java, so hopefully C# will be the same.

osher · Answer

Hi ponelat&nbsp;They use asp.net&nbsp;core to generate the Open API file from the code.&nbsp;

ponelat · Answer

hi&nbsp;osher&nbsp;there appear to be two popular libs for generating OpenAPI from ASP.net code...&nbsp;https://github.com/RicoSuter/NSwag and&nbsp;https://github.com/domaindrivendev/Swashbuckle.AspNetCore. See which of the two your team uses, and look at the options they provide to help your case.
&nbsp;

Forum Discussion

generating and updating open api from code

Related Content

Opening and updateing an excel sheet using jxl

Generate report in SoapUI Open Source

Generate JSON Schemas

mht files opening in blank Edge browser page after Edge updated to version 123.0.2420.65

Chrome updated, now TC can't find browser

Recent Discussions

Swagger Form Editor

Swagger Editor Display Fault

requestInterceptor with Python

Swagger - hide definition, BUT....

Customize Swagger like spotify web console