Yo's API Learning Developer Experience

[[141373]]

In the article "Don't Make Developers Unhappy...", we mentioned the importance of developer experience (DX). A good developer experience allows developers to quickly create the services they need through APIs, creating greater added value for your products or services. This article uses "Yo API" as an example to help everyone understand more clearly what a good API service should have.

Do you remember the "Yo App" that caused a huge sensation last year? It is an app that can only send a Yo message. You read that right, that's all it does. When Yo was first launched, everyone thought it was the dumbest idea in the world. They didn't even understand why an app that took only 8 hours to develop and could only send Yo messages could get a million-dollar investment. But since Yo opened its API, Yo has turned into a platform, allowing developers to send messages to subscribers through Yo and create many interesting applications.

1. What can Yo do?

When Yo was first launched, it could only send a message containing "Yo". However, in addition to sending Yo messages, Yo can now also send hyperlinks or your current location to your friends. Still confused? Now you can go to Yo's exclusive "Yo Store" to see what new and interesting applications developers around the world have developed with Yo.

For example, you can subscribe to Product Hunt’s service. When a product receives extremely high attention, you will receive a Yo message from Product Hunt, along with a link to the Product Hunt page for that product or service.

[[141374]]

What if your bike breaks down on the way? After subscribing to BIKESHOP's service, you can send your location to BIKESHOP, and BIKESHOP will send back the information of the nearest store that is open. Isn't it convenient?

[[141375]]

Because of the inherent characteristics of Yo itself (it can only send a Yo message), developers can clearly understand the functions provided by Yo, and through the Yo Store, users can know in what context they can use your service. Even if the user does not have a demand for the time being, the next time they encounter a similar situation, they can quickly connect the demand with your product or service.

2. Simple and clear documentation

In the previous article, we mentioned that how to quickly enable developers to build a good developer experience is a key factor. The ?Yo API documentation provides a quick start guide, which provides basic information required by developers, including how to authenticate, links to sample programs, and related scenarios. In addition, each API description also provides code examples in different programming languages ​​for developers to refer to.

Yo only provides 5 APIs, but you will probably only use one (/yoall, which sends a Yo message to all users who subscribe to your service). Each API also clearly defines the parameters, possible return content, and call examples in different programming languages. Finally, if you still have no idea, you may want to refer to the applications developed by other developers in the Code Samples to get some inspiration.

3. What should I do if I encounter problems?

If you encounter problems in development, or have ideas worth suggesting, you can search for relevant discussions on the Yo API forum, or ask questions. Good community support is an important factor in whether an API can continue to be adopted by developers. If you just open the API, but there is no place to ask when you encounter problems, and you want to suggest functions but can't find a way, the developers will eventually be frustrated and stay away from your products or services. So, don't think that your API functions are perfect enough or that the documents are well written. Developers always have all kinds of ideas that you can't imagine. Maintaining two-way communication can make your API more perfect.

Keep It Simple & Stupid!

We have to admit that the characteristics of the Yo service itself make the Yo API simple and easy to use. Of course, Yo is not perfect in terms of developer experience. For example, there is a lack of service status query, and developers cannot know whether the Yo API can currently provide normal services. These are all areas that Yo can continue to improve. But overall, the Yo App and Yo API allow us to experience what a service should look like, keeping it simple but not overly simplified (I don't think it can be simplified any further), allowing users to create the best possibilities through the Yo App and API.

Do you know of any other interesting cases? Whatever your thoughts or opinions are, please feel free to share them with us in the comments below!