From ebf60e987a5e90763b1c9caeabc7360dfbf366fb Mon Sep 17 00:00:00 2001 From: zhcnyuyang Date: Fri, 20 Jun 2025 19:35:13 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0readme=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7421700 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# post.js + +post.js is a javascript library which can help you to integrate an HTTP request testing function into your website. It is similar to Postman or Apifox etc. Now with the help of post.js, you can build a same application in a web page anywhere. + +## Who needs it? + +Here comes the people who sincerely needs to integrate our post.js into his web application: + +### Api service provider + +Now many internet application provider provides RESTful API to public in order to let 3rd parties order their interface in their own applications. To learn how to use your interface, people need to test whether your interface works, and need you to show some examples of using your interface. With a post.js module in your document page, you can show an example of using your interface and what a response looks like. User can set the arguments and send a request to your server in this module on the scene. In this way, you can show the usage of your api interface.