Quick Start: Build Your First API
Let's build an API to manage stocks in a portfolio and deploy the API to the cloud so it is available for any user to test drive and give feedback.
Step 1: Create a Project
After you log in, first create a project by clicking on the "+" button beside the Choose Project select box,
enter the project name & description on form on the the right side and click the Add Project button.
Let's Build this API
The following API allows for creating portfolios and stocks in portfolios.
| POST | /portfolios |
| GET | /portfolios |
| GET | /portfolios/{id} |
| PUT | /portfolios/{id} |
| DELETE | /portfolios/{id} |
| POST | /portfolios/{id}/stocks |
| GET | /portfolios/{id}/stocks |
| GET | /portfolios/{id}/stocks/{id} |
| PUT | /portfolios/{id}/stocks/{id} |
| DELETE | /portfolios/{id}/stocks/{id} |
Step 2: Create Path: /portfolios
Click on Add API Path and enter the path data as shown in this image
When you click on Add Path, you'll see the path appear in your list. Click on the settings icon on the right to edit the Actions you want to support for this path.
Note under Resource Types, a Resource Type was created called Portfolio which is the schema created from your JSON. And, look under Data Types, you'll see a Data Type called Broker because automatically that Broker Data Type was created from the "broker" JSON object in the portfolio.
Step 3. Add Path /portfolios/{id}/stocks
Let's create our next path by creating the Resource Type manually, i.e. not using JSON as we did for the portfolios path. Create a Stock Resource Type, specify the fields as below and click Add Resource Type.
Now that we created a Stock Resource Type lets create a Path and specify that Resource Type for the path. Click on Add API Path and enter the path data as shown in this image
After creating the path, see the Resource Types on the left.
On the left navigation, you'll see the Examples section. For each path you created, you can add/remove/delete example data for the collection.
Step 4. Add data to /portfolios
Now lets add a stock to the portfolio using the portfolios/{id}/stocks path. Note, we specify portfolio with id 1 and add the Amazon stock to our "Tech Stocks" portfolio.
Step 5. Let's deploy the API to the cloud
Click on Endpoints and configure the form on the right. Enter the names as shown below and click create.
You'll see all the information for the Endpoint with the URL at the top of page. You can instantly send requests to your new Endpoint, a curl command is provided, or use PostMan/Insomnia, etc. to send CRUD requests to your Endpoint.
More prototype artifacts are provided as below.
Further down on the Endpoint screen, you will see the endpoint keys. You will give an access key to your external users to send API requests, such as the following using the full access key:
curl -H "x-endpoint-key:fff089056d6144fc9530c557937af63e" https://api.restpoint.io/api/portfolios
You can view your Endpoint API's using Swagger UI or ReDoc. Simply copy the URL to your browser, note the Endpoint key provided by default is full access.