AstroWay/api v2.190.0 · ro
toate sistemele sunt în stare normală

Documentație creată pentru agenți AI, nu doar pentru oameni

Documentația clasică este creată pentru ochii umani: HTML frumos, evidențiere cod, navigare. Dar jumătate din traficul către docs acum sunt agenți și asistenți care au nevoie de plain-text, nu de randare. Explorăm ce am adăugat: .md-dublu pentru fiecare pagină, llms.txt, specificații mașină-citabile, dropdown 'deschide în ChatGPT / Claude' și try-it inline.

Fiecare pagină de documentație conține un fișier Markdown brut același cale cu sufixul .md. Deschizi /agent-setup - există și /agent-setup.md, același text fără ambalaj HTML, importurile MDX sunt eliminate, este returnat ca text/markdown.

Acest lucru alimentează două acțiuni în meniul paginii: Copy as Markdown (pune textul brut în clipboard pentru a-l insera într-un chat cu modelul) și View as Markdown (deschide direct versiunea .md). Agentul nu trebuie să parseze DOM - ia textul gata făcut.

Section titled “Dropdown de acțiuni în partea de sus a paginii”

În colțul din dreapta sus al fiecărei pagini există un meniu de acțiuni, creat special pentru fluxul de lucru al agentului:

  • Copy as Markdown - textul brut al paginii în clipboard
  • View as Markdown - deschide dublul .md
  • Open in ChatGPT - trimite pagina în ChatGPT cu un singur clic
  • Open in Claude - același lucru pentru Claude
  • Connect MCP - navigare la configurarea serverului MCP

În loc de “copiază URL, deschide chat, roagă să meargă pe pagină” - o singură acțiune.

Conform standardului llmstxt.org oferim două fișiere:

  • /llms.txt - indexul tuturor paginilor documentației, grupat în secții (API Reference, Use Cases, Examples, Products). O hartă pentru agent, de unde să înceapă.
  • /llms-full.txt - întreaga documentație într-un singur fișier plain-text. Pentru indexare offline într-o bază vectorială sau pentru inserarea unică în contextul modelului.

Dacă construiești RAG peste API-ul nostru, llms-full.txt este corpusul gata făcut, nu trebuie să faci crawling pe site.

Contractul este disponibil în mai multe formate pentru diferite unelte:

  • /v1/openapi.json - specificația canonică OpenAPI 3.1 cu exemple și code-samples. Pentru generarea de cod pentru clienți și orice tooling OpenAPI.
  • Alias-uri Swagger - /v1/swagger.json, /v1/v3/api-docs și altele 301-redirecționează la versiunea canonică, ca instrumentele care caută căi obișnuite să nu se împiedice.
  • Colectie Postman - /postman/astroway-api.json pentru import în Postman cu un singur clic.

Pagina /agent-setup/ - nu este un ghid general, ci instrucțiuni separate pentru șapte clienți: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Codex. Fiecare oferă configurarea exactă și un exemplu curl tools/list pentru a verifica conexiunea înainte de a scrie cod.

Pe paginile de referință API, fiecare operație are un widget încorporat try-it: inserezi cheia sandbox, editezi corpul cererii, apesi “Send” - și vezi răspunsul real, fără a ieși din documentație. Metoda, calea și exemplul de corp sunt luate din snippet-ul curl deja generat, deci widgetul nu face cereri suplimentare către openapi.json.

O teză simplă: dacă produsul tău este un API, documentația trebuie să fie potrivită nu doar pentru citire cu ochii, ci și pentru consumare de către agent. Jumătate din integrările de astăzi încep prin care dezvoltatorul aruncă link-ul către docs în Claude sau Cursor și cere “conectează asta”. Am făcut ca la celălalt capăt să fie text brut și contract de mașină, nu HTML care trebuie parsat.

Încearcă singur: deschide orice pagină de docs, apasă meniul de acțiuni din dreapta sus - și vei vedea “Open in Claude”.

MakSeong · AstroWay

I build the AstroWay API: Swiss Ephemeris on a clean REST surface, and I write about the dull parts that turn out to matter.

// construiește pe asta

Același Swiss Ephemeris ca în Solar Fire - în 4 linii de cod.

Cheie gratuită fără card. 5.000 de apeluri pe lună până la prima plată.

Mai multe din blog toate articolele →

Engineering 2026-07-15

Trei SDK-uri oficiale: TypeScript, Python, PHP în loc de curl brut

HTTP brut funcționează, dar un client tipizat economisește ore: autocompletare căi, tipuri de cerere și răspuns, retry încorporat pentru 408/409/429/5xx și ierarhie de erori în stil Stainless. Explorăm cele trei SDK-uri oficiale - @astroway/sdk (npm), astroway (PyPI), astroway/sdk (Packagist) - și cum sunt generate dintr-un contract OpenAPI unic.

Industry 2026-06-05

Free Astrology API: Which One Has the Best Free Tier in 2026?

A side-by-side of free tiers across the major astrology APIs - credits, request caps, card requirements - and how much you can actually build for free.

Engineering 2026-06-05

Horoscope API Tutorial: Build a Daily Horoscope Feature

Add daily, weekly and monthly horoscopes to your app via API - sign-based text vs transit-based personalization - with TypeScript and Python code.