Application & WorkspaceOverview

Understanding the Structure of ReAPI.com

ReAPI.com is designed to support a microservices-based architecture organized around workspaces, projects, and tests. This structure allows for efficient management of complex workflows, especially when dealing with multiple services. Here’s an overview of the main organizational layers within ReAPI:

Workspace

  • The Workspace serves as the primary container in ReAPI, housing:
    • Projects: Groups of APIs and tests related to specific applications or functionalities.
    • Team Members: Users with access rights to the workspace and its projects.
    • Public APIs: APIs available for shared access across the platform.

Project

  • Within a workspace, each Project contains resources related to a particular application or service, including:
    • Microservices (APIs): This is where you design individual APIs using ReAPI’s visual editor, making it easy to create, manage, and document endpoints visually.
    • API Tests: Project-level API tests cover interactions across multiple microservices, which is often required in a microservices architecture. ReAPI’s no-code-first editor makes it accessible to create complex API test cases without extensive coding knowledge. (For detailed organization of API tests, see the API Testing Guide.)

Tree Structure Example: E-commerce Platform

This structure illustrates a demo workspace and project hierarchy for an e-commerce platform:

E-commerce Workspace
│
├── Product Catalog Project
│ ├── Microservices
│ │ ├── Inventory Service
│ │ │ ├── API Design and Mocking (via visual editor)
│ │ ├── Pricing Service
│ │ │ ├── API Design and Mocking (via visual editor)
│ │ ├── Recommendation Service
│ │ │ ├── API Design and Mocking (via visual editor)
│ │
│ └── API Tests
│ ├── Test Suite (no-code-first editor)
│ │ ├── Inventory Tests
│ │ ├── Pricing Tests
│ │ ├── Recommendation Tests
│ └── Multi-service Tests
│
└── Team Members
├── Developer A
├── QA Lead B
└── Stakeholder C

Examples

  • Workspace Example: An e-commerce company might have a single workspace to organize all application projects, with APIs and team members centralized in this top-level container.
  • Project and Microservices Example: The “Product Catalog” project could include microservices like “Inventory Service,” “Pricing Service,” and “Recommendation Service,” each designed in ReAPI’s visual editor, making it easy for developers to set up and manage these services visually.
  • API Tests Example:
    • In this project, folders and tags can help segment tests for individual services (e.g., an “Inventory” folder for the Inventory Service).
    • For multi-service interactions, no-code-first test suites simplify complex setups for team members who may not be familiar with coding, improving accessibility and speed in the testing process.
Best PracticeTeam Management