Document and test methods of an ASP.NET Core Web API

3

Is there a tool that can list the methods of a Web API and test them?

I have already researched the site here about it and have not found specific solutions for a Web API that met what I need.

    
asked by anonymous 11.08.2017 / 13:26

2 answers

1

Yes, there is.

A widely used tool for what you are asking is Swagger.

What is Swagger?

Swagger is a project composed of some tools that help the developer of REST APIs in some tasks like:

  • API Modeling
  • Generating API documentation (readable)
  • Client and Server code generation, with support for various programming languages

How to configure?

There is a very interesting article explaining exactly what should be done to configure Swagger for your Web API.

ASP.NET Core: documentando an API with the Swagger framework

Basically what you should do is configure Swagger and then document your Controllers and object classes of your Web API through comments explaining what each one does.

Once you've done that, Swagger does the magic for you and you can view and test your methods through a generated webpage.

    
11.08.2017 / 13:36
-1

I use swagger link , but to document APIs in java and php, I found this article link , I hope you can help.

    
11.08.2017 / 13:31