Fast, Powerful API Prototyping

The benefits of API prototyping are huge but prototyping usually involved so much time and custom work/rework (web servers, code, databases, etc.) that the pain was eventually not worth the gain. But not any more.

Get Started Fast with Jumpstart Script

You can log in right now and start designing APIs. But in case you want to "kick the tires first", we developed a fast and easy Jumpstart prototyping script format for users to try our service without the need to create an account and log in.

So let's get started on a quick prototyping example. Add the following YAML script into a file called prototype.yaml ( [] denotes a list ):

---
paths:
  /students:
    response: Student[]
  /teachers:
    response: Teacher[]
  /teachers/{id}/students:
    response: Student[]
  /top-student:
    response: Student
  /courses:
    response: Course[]
components:
  Student:
    id: 1
    name: Name
    grade: 5
    average: 84.5
    buses: true
    teacher: Teacher
    courses: Course[]
  Teacher:
    id: 1
    name: Name
    homeroom:
      number: 121
      grade: 5
  Course:
    name: Math 201
    subject: Math
  Name:
    first: John
    last: Smith
      

Run:
curl -X POST --data-binary @prototype.yaml -H "Content-type: text/x-yaml" https://api.restpoint.io/sandbox/prototypes

This will build and deploy a real backend API in the Google cloud with underlying database supporting CRUD REST endpoints and a GraphQL endpoint. The response from this curl request will provide the links for accessing the auto-generated OpenAPI spec doc for this API with viewing in SwaggerUI and Redocly, Postman collection and example curl statements for each path in the API and GraphQL endpoint.

If want to do much more with your prototype, log into our service and import your prototype.yaml when you create a project to "Jumpstart" your API prototyping project. Customize HTTP actions, add logic, data, error handling and many more features to make your high fidelity API prototype look and respond like a real API backend.