quick_guide

Table of Contents

• Login & register
• Create project
• Edit API document
• Before we end

Login & register

Enter http://rap.taobao.org than register your account.

Create project

After register and login, select your team (managed by RAP server admin).

Than choose/manage your product line => group, than add a project to your group.

Edit API document

Enter edit view

Click project block to enter the API document edit workspace as below. In default, RAP is view mode, you can view document, but you can't edit. In this mode RAP will hide all edit controllers to make document easier to view.

If you want to edit, press "Edit" button to enter edit mode.

Go on editing

Using GUI to edit your document, add/remove parameters. You can import JSON data to your API document.

In this example, we:

1. add a/b/c 3 parameters
2. selected data types for them
3. Click API DETAILS area, add Action URL, written something you like, eg-> /get/data.json, than confirm

After all things done, click Fast Save button to save the document.

Mock data / validate API

Click button of page to enter the API toolbox page.

Press MockJS Data button, you can see RAP can generate mock data based on your API data.

Before we end

This quick guide is a easy and quick guide of how to use RAP. How to manage mock rules? Any questions on API edit and mock/validate tools, please read user manual for details.

Any questions, freely create issues here, or send me an e-mail :)