Discussion on "Designing REST APIs in .NET 5"

Gabriel · 2021-02-13T16:07:48.787Z

REST stands for Representational State Transfer and it is a specification for building APIs. This standard is language agnostic which means it applies to building APIs in any language of choice. This article does not go in depth in explaining the con...

My leader sir, I am here again ooooo.

Apparently, I have concluded the code along of the above project, like I noted in my last question when I scaffold a new project template, it already came with a Swagger template already registered in the Startup class. However, I commented out the default swagger registration in the startup class so I could follow yours as described above but when I run the project it throws an error. When I launch the project it goes to this path localhost/swagger/index.html and I see a default swagger UI similar to yours. But when I navigate to /genre it throws an error "This localhost page can’t be found No webpage was found for the web address: localhost/genre HTTP ERROR 404"

Here is a link to my github repo of my codes github.com/dyagzy/.Net5RestApi

I will appreciate if you can help debug this... now I will move on to code up the Unit test project while I wait for you...

Thank you in advance chief.

Okay. Do you know how to use Swagger? When using Swagger you don't have to change the URL or navigate to any of the actions. The documentation provides ways on how to go about it. You simply just have to click on the endpoint you want to test and follow the instructions and it calls the data you need.

Thank you for taking the time to elaborate on the above subject. I am still kind of new to the tech so permit me to ask the following naive questions.

Why did you have to configure swagger again when by default swagger is already configured to the start up class of the. Net5.0 project template?
How did you come about all the data annotations and why did you have to use them on all those controller action methods?
I didn't really get the difference between the Update Patch method and why you have to use a JsonPatchDoc and all that.

You didn't specify the version number for each of the various nuggets packages you installed am asking because I still get confused on how to know which package number to install on a particular project especially when such a package has different variations of it's packages.
For the application to access the table in the database, it has to be configured as a service in the DI (Dependency Injection) Container located in the Startup.cs file. You didn't show the code section for this, I think it was an omission.
I am new to everything you had described above so I would like to code along then revert back to you if I have a bug or if I have more questions. Once again I am very grateful for the opportunity to learn from you via this article.

I added some custom configuration to add API Versioning into the Swagger Doc in the ConfigureSwaggerOptions class so this demands that I reconfigure the existing configuration model.
The data annotations I used are built into the ASP.NET Core runtime. I added them as part of the documentatng status code into Swagger Documentation which is available when you run the application.
Using JsonPatchDoc is .NET best practice for PATCH REQUEST. It is different from PUT. PATCH request updates only one part of the resource while with PUT you can update one or more part of the resource.

Check docs.microsoft.com/en-us/aspnet/core/web-api/json… for more on configuring and using PATCH request.

If you're using .NET 5 to follow along you can install the latest version of the nuget package.
It's was not omitted. Might be a network challenge from your end.
Thanks for your comprehensive feedback. I'm always available if you have more questions.

Discussion

Designing REST APIs in .NET 5

Responses(3)

Recent in Forum

Search Hashnode

Designing REST APIs in .NET 5

Responses(3)

Recent in Forum