-
Notifications
You must be signed in to change notification settings - Fork 151
Project
A step further to keep your set of APIs clean and separate is to create different projects within the same workspace. You can opt to create different projects when APIs are part of different modules, i.e. related to each other but providing totally different functionalities.
A Project is a top level entity within a workspace where all the request/response are organized.
In the left navigation column, click on + symbol against Projects.
You can see a modal with project name and description fields to create the new project.
###Request Tree
When you click on any project in left navigation, all the folders and requests within a project are displayed in the form of a tree in the middle column. This tree has no limitation on number of child folders/requests. A request or folder can exist as a node at any level down the tree.
Folders are meant to keep your requests in an organized manner. New Folder button above the request tree creates a folder under selected node or at the root. Similarly New Request is meant for creating a request. More about New Request is here.
###Node Menus
Hover mouse over any of the nodes in the request tree, a down arrow appears. Clicking on the arrow will display the actions associated with the node i.e. Edit, Delete, Copy Node.
Edit Node
Edit node for a request allows editing its name and description.
Delete Node
This option asks for confirming deletion of node.
Copy Node
Copy Node copies a request and the checked attributes to a new request. Default name of node is Copy of RequestNodeName, which can be changed.
Getting projects within a workspace
GET http://localhost:8080/api/workspaces/{workspaceId}/projects
Getting project by Id
GET http://localhost:8080/api/workspaces/{workspaceId}/projects/{projectId}
Creating a new project
POST http://localhost:8080/api/workspaces/{workspaceId}/projects
{"name" : "New Project Name"}
Updating an existing project
PUT http://localhost:8080/api/workspaces/{workspaceId}/projects/{projectId}
{ “id” : projectId, "name" : “Another Project"}
Deleting an existing project
DELETE http://localhost:8080/api/workspaces/{workspaceId}/projects/{projectId}