Skygear 1.0 Released: API Regrouping to Improve Discoverability

We are excited to announce the release of Skygear v1.0. In this release, we’ve improved the discoverability of APIs to help developers build web and mobile apps more quickly on our serverless platform.

Existing apps will stay on Skygear v0.24. Please remember to pin your SDK at v0.24 or lower as well. Migration documentation for apps developed with v0.24 are coming soon!

Skygear v1.0’s regrouped APIs are the groundwork for many new features and Skygear v1.1 will be released a week after v1.0 with improved user profile discovery. The Skygear portal will reflect the latest v1.1.0 upgrade. All new apps created on Skygear.io will be created with Skygear v1.1.0. You can confirm your version in the Settings page of your Skygear developer portal.

serverless baas dashboard open source
Go to your developer portal Settings page to verify your Skygear version.

How we have regrouped the APIs

Serverless solutions are designed to help developers build products more efficiently. Knowing what grouped APIs are available will save you hours of creating additional features from scratch. We have regrouped Skygear’s APIs into smaller containers so that you can discover them more easily.

We have split our previous container into smaller containers according to the Skygear SDK’s 6 key features. This regrouping provides consistency in our API naming for both documentation and for code editors with autocomplete.

For example, If you want to learn about auth related APIs for JS, you can get the whole list from the auth container documentation.

Under the new grouping, APIs are now updated to include the container name. For example, the sign up method skygear.signupWithUsername is now updated to skygear.auth.signupWithUsername.

Skygear SDK APIs are now grouped under the following 6 containers:

  1. PublicDB
  2. PrivateDB
  3. Auth
  4. Pubsub
  5. Push
  6. Relation

The implications of this regrouping can affect several features. For example, all things to do with passwords and authentication are now grouped consistently under the auth container.

You can find the API references here: JS, iOS, and Android

Two additional features that are not included in the SDK can be found on Skygear.io’s GitHub repository:
* Event Tracking
* Chat

Continuity of v0.24

We will continue to support v0.24 mainly for bug fixing.

For v0.24 or below users, you can access the v0 documentation and the API references here.

Create a new app with Skygear v1 and tell us what you think!

Skygear is an open-source serverless platform. Check out our docs and set up your free account today!

You can download the open-source repo here: https://github.com/SkygearIO

Leave a Reply