OpenAPI Spec at Build Time?
# package-developmentw
Warren Buckley
10/10/2024, 9:31 AMHas anyone managed to build an OpenAPI/Swagger JSON document at C# Build time as opposed to having SwashBuckle serve it dynamically from the server?
Warren Buckley
10/10/2024, 9:33 AMI am just trying to improve the flow a little so that the openapi doc is saved to disk and can be versioned controlled in git and also so that the TypeScript generation does not depend on the website being running to generate a new TS HTTP API client
Warren Buckley
10/10/2024, 9:33 AMI have seen this
https://khalidabuhakmeh.com/generate-aspnet-core-openapi-spec-at-build-time
I can't get it to work with my RCL project though :S
m
Markus Johansson
10/15/2024, 3:14 PMAre you planing to point hey-api/openapi-ts to this static file to build the typescript-stuff or are you looking to use any other tool?
I used to have a setup where a console app would build my ts-files (for AngularJS), but I must say that I',m not that bortherd by the "official" setup with having to run "npm generate:api" after a change has been made.
w
Warren Buckley
10/15/2024, 5:42 PMYeh it’s fine for me
Warren Buckley
10/15/2024, 5:42 PMI was just trying to help simplify the dotnet new template
Warren Buckley
10/15/2024, 5:42 PMIt’s another thing you need to know about
Warren Buckley
10/15/2024, 5:42 PMSo if MSbuild can create the yank/json
Warren Buckley
10/15/2024, 5:43 PMThen the node is scripts for build/dev could regenerate the TS api everytime
Warren Buckley
10/15/2024, 5:43 PMSo it’s one thing less to know/worry about was my thinking for new people.
Warren Buckley
10/15/2024, 5:45 PMI can get it to work but just not in an RCL project as it needs a C# Apphost/entrypoint and this RCL & client side dotnet new template won’t be able to do. So for now parked this idea unlesss anyone has smart thoughts.
w
Warren Buckley
10/17/2024, 8:07 AMSwashbuckle & NSwag community packages is being replaced in .NET9 with their own stuff
3 Views