#196 Publish a global dotnet tool (AsyncAPI.Saunter.Generator.Cli)

[smoerijf]

Description
tool to generate an asyncApi spec from a startup assembly.
Implementation inspired by https://www.nuget.org/packages/Swashbuckle.AspNetCore.Cli

I already took the freedom to upload to nuget: https://www.nuget.org/packages/AsyncAPI.Saunter.Generator.Cli

Uses the Lego AsyncApi.net nuget packages to also export yml spec files.

Related issue(s)
#196

[smoerijf]

current files were using a size of 2 and lf line endings, so I changed it (because my VS defaults are different)

[yurvon-screamo]

It's a great decision, and you're well on your way, but the product is not yet ready for release to users.

[smoerijf]

I'm happy to comply with the new formatting style rules or with changes from PRs like #201

@yurvon-screamo is it possible to assign issues to me? #196 #197 #207 (Or can you assign rights if I may do that myself?)

[yurvon-screamo]

I'm happy to comply with the new formatting style rules or with changes from PRs like #201

@yurvon-screamo is it possible to assign issues to me? #196 #197 #207 (Or can you assign rights if I may do that myself?)

don't rush too much, I'm finishing the translation to the LEGO library, better wait for it so as not to solve a million conflicts...

[smoerijf]

I didn't know you were working on the LEGO migration, just saw your draft PR. Very nice to see!

If any more conflicts arise, I'll resolve them too.

[smoerijf]

I think all remarks have been addressed. All the working parts are unit tested. I've also made changes to the ci workflows to run all tests (not just the 2 projects that already existed.) and to also release based on the solution, not just the main Saunter csproj (release pipeline changes are not tested)

[smoerijf]

Added 2nd example project (also to be used in integration test) because Top Level Statement projects initially didn't work with the Generator.Cli tool. Now it does work too. And proves using integration test that both NET6 & NET8 targets work.

[7CLewis]

@yurvon-screamo Any idea when this might get merged and added? Would love to be able to use this tool.

[7CLewis]

@smoerijf Your prerelease version on NuGet does not work with function apps. They do not have a standard Startup.cs file, and it seems to be having issues with that.

[smoerijf]

@smoerijf Your prerelease version on NuGet does not work with function apps. They do not have a standard Startup.cs file, and it seems to be having issues with that.

Thank you for trying the prerelease. I've never worked with function apps, is that the same as Azure functions? Don't those apps have a Main or ServiceProvider?

How this tools works: Inspect the DLL to find the main entrypoint and build the IServiceProvider. That IServiceProvider is used to create instances of Saunter's IAsyncApiDocumentProvider class. This is the same approach as Entity Framework Migrations (I'm using an EF nuget package to extract the IServiceProvider from the DLL). So this tool should support the same type of apps as EF does.

As I've no experience at all with function apps, I've no idea how they are structured or how Saunter library integrates with them. If they work with EF migrations, could you share a (minimal) example with Saunter?

[7CLewis]

@smoerijf Your prerelease version on NuGet does not work with function apps. They do not have a standard Startup.cs file, and it seems to be having issues with that.

Thank you for trying the prerelease. I've never worked with function apps, is that the same as Azure functions? Don't those apps have a Main or ServiceProvider?

How this tools works: Inspect the DLL to find the main entrypoint and build the IServiceProvider. That IServiceProvider is used to create instances of Saunter's IAsyncApiDocumentProvider class. This is the same approach as Entity Framework Migrations (I'm using an EF nuget package to extract the IServiceProvider from the DLL). So this tool should support the same type of apps as EF does.

As I've no experience at all with function apps, I've no idea how they are structured or how Saunter library integrates with them. If they work with EF migrations, could you share a (minimal) example with Saunter?

Here's a minimal example: https://github.com/7CLewis/SaunterFunctionApp. If you Build that and then try to run dotnet asyncapi tofile [path_to_repo]\bin\Debug\net6.0\SaunterFunctionApp.dll --format "json", it'll give that error I mentioned.

Azure Function apps do not have a normal Startup like regular apps, as you can see from that example. I haven't tried EF Migrations with AzFuncs, so I can't speak to that.

[drdamour]

@smoerijf when u do ef core in AzF where startup doesn't exists you have to offer up a Design Time Factory as doc'd here https://learn.microsoft.com/en-us/ef/core/cli/dbcontext-creation?tabs=dotnet-core-cli#from-a-design-time-factory

could something similar be done in saunter where before looking for startup stuff...it would look for a specific public type implementing an interface.