Creating APIs

Creating APIs is fast and easy from the attainable dashboard.

From the API Editor, follow these steps:

1. Give the API a name.
2. Choose a size.
3. Edit the Resource Description
4. Deploy!

API management

From the left-hand menu select APIs and you’ll see all of your APIs. To create an API select a plan size from the dropdown “Launch an API” and it will open the API Editor. You’ll be provided a form to design your Resource Description, and when you deploy your API it will be ready in moments.

Resource Description

You design your attainable API with a resource description, using YAML syntax and familiar data types. Read more about Resource Desccriptions here..

The example below is a typical blog data schema written as a resource description for an Attainable API.

post:
  slug: string
  title: string
  body: string
  published: datetime
  categories: << category
  tags: << tag

user:
  name: string

comment:
  body: string
  post: < post
  user: < user

category:
  name: string
  slug: string

tag:
  name: string
  slug: string

Create a Micro API now!

Choosing an API size

API sizes are based on requests per second scale. In rough estimations you can expect the following:

• Micro API can handle up to 100 requests per second.
• Small API can handle up to 200 requests per second.
• Medium and Large APIs can handle up to 300+ requests per second.

Note

Attainable performance tests each plan against resource descriptions with as much variable data and dynamic traffic patterns as possible. These estimations might not match your experience depending on the size and structure of your resources.

Storage

API Storage is managed for you automatically. Storage is increased in 20GB increments, every time you reach 75% capacity.

• Micro starts with 10GB
• Small, Medium, and Large start with 30GB