• Что бы вступить в ряды "Принятый кодер" Вам нужно:
    Написать 10 полезных сообщений или тем и Получить 10 симпатий.
    Для того кто не хочет терять время,может пожертвовать средства для поддержки сервеса, и вступить в ряды VIP на месяц, дополнительная информация в лс.

  • Пользаватели которые будут спамить, уходят в бан без предупреждения. Спам сообщения определяется администрацией и модератором.

  • Гость, Что бы Вы хотели увидеть на нашем Форуме? Изложить свои идеи и пожелания по улучшению форума Вы можете поделиться с нами здесь. ----> Перейдите сюда
  • Все пользователи не прошедшие проверку электронной почты будут заблокированы. Все вопросы с разблокировкой обращайтесь по адресу электронной почте : info@guardianelinks.com . Не пришло сообщение о проверке или о сбросе также сообщите нам.

Why API design is a mess, and how could a git-native tool help?

Lomanu4 Оффлайн

Lomanu4

Команда форума
Администратор
Регистрация
1 Мар 2015
Сообщения
1,481
Баллы
155
In my dev years and throughout my devrel career, I’ve spent A LOT of time wrangling APIs and devtools (together and separately).

API governance is a pain, been for a while.
Cloud-sync which you don't feel comfortable with, scattered or non-existent docs, rewriting the same stuff all over again, and don’t even get me started on the tools that feel like a full-on enterprise bloat.

Been there, cursed that, got frustrated - a LOT.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.



The API workflow mess


Well, just recently I got affiliated with

Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.

. Given this recent affiliation, I’ve been digging into API tools again. You know, checking what works, what is painful, etc. And I want your take as well.

API specs and docs are critical for public-facing microservices, and some internal ones may need them even more. They’re a mess to manage. Currently, we have sources of truth scattered everywhere, specs drifting from code, docs living in another tool, you have some dashboards that nobody checks, and overall, governance is pure chaos.

Most tools don’t help:

  • Cloud sync feels like a data leak waiting to happen.
  • Bloated UIs waste time when you just need a quick endpoint test.
  • Specs and docs in separate places kill your flow.
  • And wth is real-time collaboration? Make. Your. Own. Branch.

Naturally, I checked out the landscape to see what's what.
Here’s what I found, in short, straight from using them.

API tools: what works, what doesn’t


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: Enterprise-ready and collaborative, CI/CD integration, flows, lots of everything you may eventually need.

Bad: UI feels cluttered for small projects, free tier caps at 25 collection runs, cloud sync is not for privacy nerds. One change starts a chain reaction.

Best for: Big teams with end-to-end API needs, and stable APIs that don’t change.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: OpenAPI focus, cloud or local sync, solid for structured designs.

Bad: No built-in docs, limited reusability, limited extensibility, that cloud-sync thingy all over again.

Best for: Teams all-in on OpenAPI.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: Fast, free, browser-only testing with unlimited workspaces.

Bad: No Git, no reusable components, no docs, too basic for complex APIs.

Best for: Frontend devs doing quick in-browser checks.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: Cheaper than Postman, cloud collab, mock servers.

Bad: Free tier limitations. Cloud-only unless you pay for on-prem.

Best for: Enterprise on a budget.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: Open-source, offline, git-sync, tests for DevOps pipelines.

Bad: No docs, free-tier testing limited.

Best for: Git-loving OSS fans.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.




Good: Open-source, offline, git-sync, dynamic requests for flexible setups.

Bad: No docs, experimental plugins.

Best for: OSS fans, distributed system builders.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.

:



Good: CLI testing for minimal setups, great for scripts.

Bad: Only for running APIs, not designing. No UI, no extensibility.

Best for: CLI purists.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.

(my thing)



Good: Git-native, offline, markdown for specs/docs/tests. It imports Postman and enables reusable blocks and plugins.

Bad: Early days, small community, features still in development.

Best for: Devs who treat APIs like code, and hate cloud sync.

Why Voiden makes sense


Voiden is built like software.
Specs are markdown, versioned in Git, and offline-first.
Specs and docs kept together, blocks reusable across the project.
In-app terminal with git gives you branches, diffs, and governance without real-time sync clutter.

Need nothing but a simple GET API call?


Here is what the simplest of calls would look like:


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.



How to reproduce it:

  1. Hit Cmd+N (Mac) or Ctrl+N (Win/Linux) to create a new file.
  2. Type /endpoint to create a new (GET by default) request block.
  3. Type or paste the URL you want to trigger a GET request to.
  4. Hit Cmd+Enter (Mac) or Ctrl+Enter (Win/Linux) to run it.

And now you check the response.

You need something more complex than that?


No problem.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.



  1. Hit Cmd+N (Mac) or Ctrl+N (Win/Linux) to create a new file.
  2. Type /endpoint to create a new (GET by default) request block.
  3. Replace GET with POST.
  4. Type or paste the URL you want to trigger a request to.
  5. Type /headers to add a API Headers block.
  6. Populate the key-value pairs of the headers block.
  7. Type /json to add a API Body block.
  8. Populate the JSON block with the request body object.
  9. Hit Cmd+Enter (Mac) or Ctrl+Enter (Win/Linux) to run it.

You can run requests with a keystroke and see responses instantly in the panel. Document your endpoints naturally using plain Markdown: descriptions, examples, even error cases. No switching tabs, no sync delays, just specs that live where they should: with your code.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.



Your API pain points


We’ve all got scars: specs out of sync, cloud sync crashing, tools promising the world and delivering bugs. I’ve raged at Postman’s UI lag. What’s your deal? How do you keep API specs and docs in check? Specifically:

  • How do you sync specs with code or microservices?
  • What hacks fix governance or reusability?
  • How do you handle specs and docs being split?

Hit the comments with your pain points, workflows, or tools I missed. I may be with Voiden, but I’m here to learn what devs like you need. Let’s sort this API mess out, once and for all.


Пожалуйста Авторизируйтесь или Зарегистрируйтесь для просмотра скрытого текста.

 
Вверх Снизу