cancel
Showing results for 
Search instead for 
Did you mean: 

How to generate document for Rest API request?

Hemakumari
Occasional Visitor

How to generate document for Rest API request?

Please help me how to generate a document for a Rest API request

1 REPLY 1
PrathapR
Community Leader

Re: How to generate document for Rest API request?

Hey @Hemakumari 

 

What Kind of document you are looking for?,

 

Usually developers do documents and they provide to testers to test all possibilities from that doc.

 

If you are talking about API doc, we can achieve by

 

1) Swagger UI (https://swagger.io/tools/swagger-ui/)

or

2) MS word, It's a traditional model. It should contains end points, method(Get,Post etc..), Path/Query parameters, sample request body(If Post),expected  HTTP codes (Including errors(400,404, 500 etc..)) and sample response body etcc..

 

Thanks!

New Here?
Join us and watch the welcome video:
Announcements