asyncapi / saunter

Saunter is a code-first AsyncAPI documentation generator for dotnet.
https://www.asyncapi.com/
MIT License
194 stars 55 forks source link

[FEATURE] Migrate to DTO from AsyncApi.Net #188

Open yurvon-screamo opened 4 months ago

yurvon-screamo commented 4 months ago

Why do we need this improvement?

Reducing the complexity of the project and the cost of supporting the scheme

How will this change help?

We will use ready-made data schemas and greatly reduce the cost of supporting new versions of asyncapi

Screenshots

No response

How could it be implemented/designed?

1) Remove the schema definition from the project. 2) Transfer serializers to AsyncAPI.NET 3) Adapt the functionality of the document name to the new schemes

https://github.com/LEGO/AsyncAPI.NET/

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

yurvon-screamo commented 1 month ago

Hi, @VisualBean. I continue to actively implement the AsyncApi at work, we need version 3 of the specification, how are things going with this in LEGO now, should I start implementing here or wait and inject LEGO?

VisualBean commented 1 month ago

I'm currently working on implementing avro for message schemas,and then picking up 3.0 right after that. So hopefully won't take too long now.

yurvon-screamo commented 1 month ago

I'm currently working on implementing avro for message schemas,and then picking up 3.0 right after that. So hopefully won't take too long now.

Can I help you?

VisualBean commented 1 month ago

If you make a branch and start migrating to asyncapi.net, the 3.0 will of course have breaking changes, but all of the reading and writing will mostly stay exactly the same. So it should be almost as simple as upgrading the NuGet once in saunter. It would help a lot starting the implementation here along side me building 3.0 for aayncapi.net.

yurvon-screamo commented 1 month ago

If you make a branch and start migrating to asyncapi.net, the 3.0 will of course have breaking changes, but all of the reading and writing will mostly stay exactly the same. So it should be almost as simple as upgrading the NuGet once in saunter. It would help a lot starting the implementation here along side me building 3.0 for aayncapi.net.

Okay, I hope I'll be done by the end of the week.

yurvon-screamo commented 1 month ago

If you make a branch and start migrating to asyncapi.net, the 3.0 will of course have breaking changes, but all of the reading and writing will mostly stay exactly the same. So it should be almost as simple as upgrading the NuGet once in saunter. It would help a lot starting the implementation here along side me building 3.0 for aayncapi.net.

Hi, I'm stuck on creating an instance of AsyncApiSchema from a message type, do you have any ideas other than a manual map?)

VisualBean commented 1 month ago

Not completely sure what you mean; but essentially you would need a map (if you can't infer it some other way) if you point me at some code I might be able to help more as I need a bit more to go on to know exactly what you are looking for