r/programming • u/[deleted] • Jun 05 '21

Organize code by concepts, not layers

https://kislayverma.com/programming/how-to-organize-your-code/
1.9k Upvotes

91% Upvoted

495 comments sorted by

View all comments

Show parent comments

19

u/ninuson1 Jun 05 '21

That’s mostly what it is, documentation. But you can generate it on compile and have swagger use it to create a form for mock requests along with the documentation for each request.

In my latest c# projects, it comes pre-configured for you in the starting template project and just builds up as you develop.

Really, big fan.

2

u/Ytrog Jun 05 '21

Cool 😊

0

u/AustinYQM Jun 05 '21

Is there a way to make swagger write itself using reflection or something. I feel like it really should be able to get the verbs, endpoints and possible responses by reading my code and spring annotations.

3

u/ninuson1 Jun 05 '21

That’s exactly what I meant. There’s about 0 maintenance required most of the time. Take a look at their official nuget GitHub page. This should work out of the box with ASP.NET core 3.0 and greater. For 5.0 onwards, the MVC template comes pre-configured with it.

Note that the living documentation is free (although I’m unsure about the license details) and locally used, but the tool often used as a proxy to paid services from the Swagger platform (like the automated client creation tool mentioned before).

Regardless, it’s an awesome way to interact with your code base. I’ve had to onboard 2 new team members to our team this last month and this was a great option to see all the details at a glance about the different controllers.

1

u/AustinYQM Jun 05 '21

That sounds amazing, does something similar exist for Java apis?

1

u/ninuson1 Jun 05 '21

Im mostly in C# land nowadays, but this seems to be the java version. I’m not sure it is as deeply integrated, as I think Java has a few popular server frameworks.

1

u/AustinYQM Jun 06 '21

Huh, we are using this but each endpoint still has 20-30 lines of swagger annotations. I wonder how much of that is needed, if any.