Table of Contents
- Develop and Debug with the API Client
- Seamlessly Sync Between Environments
- Create Comprehensive Tests from Development Through Deployment
- Manage and Monetize Your API from the Hub Listing
- Improving the API Developer Experience
Building, testing, publishing, and collaboratively working with a team on APIs can be a disjointed developer experience. Moving from coding to testing, to publishing and consuming APIs often forces developers to jump from one application to the next. This costs time and the loss of context you move between experiences. That is why today we’re excited to announce the launch of RapidAPI Studio — bringing all of your APIs and development needs together in one place.
With RapidAPI Studio, you can build, consume, manage, and monetize your APIs in one connected experience. RapidAPI Studio streamlines collaboration, making it easy to work with your team and across your preferred platform on the web, native apps, or popular IDEs such as VS Code.
Develop and Debug with the API Client
With requests in RapidAPI Studio, you can create and send requests, view and debug responses, and use environment variables and dynamic values to speed up the development process.
Here you can import API projects from OpenAPI, a Postman collection, or GraphQL schema and keep them organized by team. Organize your APIs by favoriting the ones that matter most, and tab between viewing all your projects or just your favorites. Additionally, you can easily switch between personal and team accounts to access and collaborate on all your projects.
Follow the steps below to get started.
Step 1: Sign-Up for a Free Account on RapidAPI
You can get started with RapidAPI Studio by either creating a new account on RapidAPI, or if you’re using the Paw application, use those credentials to access your RapidAPI account.
Step 2: Create a New API Project or Manage Existing Projects
Once you’re logged into RapidAPI Studio, you’ll either see your existing API Projects, or if you have a new account, you’ll be prompted to create your first API Project. If you want to explore the new features before creating your first API Project, you can use the Onboarding Project available in the API Projects dashboard.
The API Projects dashboard if you’re a new user.
The API Projects dashboard if you have existing projects.
Step 3: Select a Project to Access Everything Needed to Manage and Build Your API
Once you’ve selected your project, you’ll be taken to the Requests user interface where you can create and send requests. You can also access the rest of your API tools for Testing, the Hub Listing and Settings.
Create and send requests from the request tool.
If you want to easily switch between API Projects, you can do so from the top navigation. Just click on the API Project name next to “API Projects” in the middle of your top navigation bar and select a project from the dropdown.
Easily switch between API Projects from the main navigation bar.
Seamlessly Sync Between Environments
Stay in context of your workflow even as you move between the browser and your preferred IDE. With RapidAPI Studio you can work in Visual Studio Code using RapidAPI’s VS Code extension. From our interface you can compose requests, inspect server responses, generate client code, and export API definitions without ever switching context to another application.
Step 1: Install the RapidAPI Client for VS Code Extension
Head to the VS Code Extension Marketplace or install the extension from the command line. Once installed, open the extension tab and click the “Sign In” icon in the upper left corner of the UI.
Step 2: Sign-In to Your RapidAPI Account From the VS Code Extension
Clicking the “Sign In” icon will prompt you to sign in using Octopaw. Select “Allow” and this will open your browser.
You will then be asked to login with your RapidAPI account which will connect VS Code to your RapidAPI account for bidirectional syncing.
This will redirect you back to the RapidAPI Client for VS Code Extension and you’ll now be able to access your existing API Projects, or create new ones, right in VS Code.
Step 3: Open an Existing API Project or Create a New One
To do this, select the “Projects” icon next to the “Sign In” icon in the upper left corner of the user interface and your projects will appear as a dropdown from the middle of the toolbar.
Step 4: Sync Your Projects
Once you open a project, a sync icon will appear next to the “Projects” and “Sign In” icons. While you are able to force sync via this icon, project syncing is instant and automatic so once you make a change in VS Code, you should be able to see it in the browser experience on RapidAPI Studio.
Create Comprehensive Tests from Development Through Deployment
RapidAPI Studio keeps all your development needs centralized and that includes API testing. With RapidAPI testing you’re able to easily access the requests you’ve built in the API client and visual, code based, or automated tests through an intuitive UI to ensure your APIs functionality. Monitor your APIs’ performance, set failure alerts, how you want to receive those alerts, and set up different environments to test across and integrate with your CD/CI pipeline.
Step 1: Create a Test
Head to the “Tests” dashboard from the sidebar navigation and click either of the components that say “Create Test” and name your test.
Step 2: Construct your Test
Construct visual, code based or automated tests depending on your preference. Easily switch between the “Visual” and “Code” tabs for creating your test.
Visually create a test with the intuitive UI
Step 3: Run Your Test and View the Results
To run your test, hit the “Run” button in the upper right corner. Once your test is complete, select the test result item under “Recent Results.”
A popup will give you more details about the test execution.
This is just a brief overview of what you can do with Testing in RapidAPI Studio. To find out more about Testing, check out the documentation available on the RapidAPI Documentation site.
Manage and Monetize Your API from the Hub Listing
The Hub Listing is your central resource for managing your API on the RapidAPI Hub. From this interface, you can manage all aspects of your API including hub listing details, gateway configurations, endpoint definitions and view analytics. You can also manage and customize your plan for those APIs you wish to monetize. Once you have your API information entered and you’re ready to make it available to the public, toggle the visibility of your API project from “Private” to “Public” and your API is ready for consumption on the RapidAPI Hub
Manage the Visibility of your API on the RapidAPI Hub
From the “General” tab of the Hub Listing interface you’re able to manage the basic details of your API, including logo, category, description, visibility, and some other optional fields. When you’re ready to make your API available on RapidAPI Hub, scroll down to the bottom of the page and toggle the visibility from “Private” to “Public.”
Add and Define Endpoint Definitions
Manage your endpoints and their definitions manually or upload an OpenAPI specification file in the “Endpoints” tab.
After you’ve added endpoints, you can head back to the Requests tab, and sync your Requests from the Hub so you don’t have to duplicate any of your work.
Sync requests from and to your Hub listing.
Monetize your API
You can set up monetization of your API using the “Monetize” tab.
Manage the settings for the different types of public plans available, like whether you’d like to use a monthly subscription or pay per use.
You can also set your payout account information from the main navigation dropdown on the right hand side to start collecting your API earnings. To learn more about the process for payouts read more on our finance documentation page.
Improving the API Developer Experience
We’re excited to introduce RapidAPI Studio to streamline your API development workflow and this is only the beginning. We want to ensure that we’re building tools that integrate and improve the efficiency of your workflow so that you can accomplish more of what matters to you. As you use our new tools, we’ll be monitoring feedback and are eager to hear about what you love, what we can do better, and and which additional features you’d like to see.
Submit feedback to us via RapidAPI Studio’s “Help” menu.
Connect with us on Twitter or submit feedback via RapidAPI Studio under the “Help” menu or through the new VS Code Extension.