15 posts tagged with "Konfig"

We are excited to announce the launch of our newest product at Konfig!

Introducing: API Reference

​

The Problem​

The next step after generating SDKs is adding them to your docs. But as soon as you do, something feels off. Your API reference is not integrated with your SDKs and you have to maintain two separate pages. You manually copy-paste code snippets from your SDKs to your docs and you have to update them every time your API changes. So we created a better way.

The Solution​

Introducing API Reference by Konfig. It's a single page that combines your API reference and SDKs. It's automatically generated from your OpenAPI spec and SDKs. It's always up-to-date and it's always in sync with your API. It allows you to dynamically generate code snippets for your SDKs and make API requests directly from your docs. It's a single source of truth for your API.

Currently, we are deploying with a few early customers. If you are interested in trying it out, please reach out to dylan@konfigthis.com.

Last week we merged our plugin into Backstage (Pull Request) to generate SDKs for internal services. For those that love to follow and discuss technology, we also published a blog post where Dylan reviewed 1,000s of GraphQL vs. REST perspectives. We also made a lot of improvements to our Python, TypeScript, and PHP SDK generators.

Backstage Plugin​

SDKs help onboard external developers but we know that the same problem exists inside organizations when integrating APIs from different teams owning different services. Backstage is a developer portal for centralizing your infrastructure and enabling product teams to quickly ship high-quality code. So we created a Backstage plugin to auto-generate SDKs for internal API services. If you are interested in generating SDKs for your internal APIs please reach out to us and we would love to talk. Check out our official plugin here!

Blog Post: I Reviewed 1,000s of GraphQL vs. REST Perspectives​

Ask any developer: do you prefer GraphQL or REST? This often leads to opinionated conversations, sometimes even devolving into vulgar opinions rather than objective facts. To delve into the GraphQL vs. REST debate, I scoured platforms where developers frequently discuss such matters: YouTube, Reddit, Twitter, and Hacker News. I parsed 1,000s of discussions and synthesized my findings in this blog post, striving to present only thought-provoking perspectives. Read more here!

Industry: Fintech

Results​

At Konfig, we are rapidly making progress towards building the easiest way to onboard developers to your API. To keep our followers up-to-date, we are starting this newsletter that will feature 2-3 of our biggest product updates and little fixes.

STATISTICS.md​

Now konfig generate will generate a file named STATISTICS.md that contains a count for Lines of Code in each SDK for your API. Here is an example that we generated. This file is generated in the same directory as your konfig.yaml file. In the future, we would also like to add more data such as weekly downloads.

Interactive Tutorial​

Our interactive tutorial is now live! Learn how to generate SDKs with a guided interface. This is a great way to get started with Konfig if you would like to generate SDKs yourself.

Improved TypeScript SDK Error​

Instead of just throwing the error from the underlying request library, axios, we now generate a file called error.ts that contains a custom Error class. The name of the class is based off the client name in your konfig.yaml file. The new custom error message has a cleaner interface and better inline documentation. In a Next.js API environment, the logged errors now exclude a lot of the garbage that was not helpful when debugging.

If you are on a desktop, you can run through the tutorial in a browser by clicking here. We also filmed a video in case you would rather sit back and watch.