Scalar

Scalar is een platform voor het maken van API-documentatie die er professioneel uitziet en soepel werkt. Je levert je OpenAPI-document aan, en Scalar zet het om in gemakkelijk leesbare pagina's met ingebouwde voorbeelden en testtools.

Het platform biedt verschillende producten die samenwerken. De API Reference toont je documentatie in een overzichtelijke lay-out. De API Client stelt ontwikkelaars in staat om endpoints direct te testen. Het platform bevat ook tools voor het beheren van meerdere versies van je API-documenten en het synchroniseren met GitHub.

Scalar is volledig open-source, wat betekent dat de code openbaar en gratis te gebruiken is. Je kunt het zelf hosten of hun cloudservice gebruiken. Het gratis abonnement dekt basisfuncties, terwijl betaalde abonnementen samenwerkingshulpmiddelen, aangepaste domeinen en betere ondersteuning toevoegen.

Het gebruik van Scalar is eenvoudig en vereist geen complexe installatie. Hier zijn de stappen om aan de slag te gaan:

• Bezoek de Scalar-website en maak een gratis account aan om je werk op te slaan. Je krijgt een gratis subdomein zoals jouwnaam.apidocumentation.com.

• Upload je OpenAPI-document door een URL te plakken, een bestand te uploaden of verbinding te maken met GitHub. Scalar ondersteunt zowel JSON- als YAML-formaten.

• Kies een thema en pas de kleuren aan om bij je merk te passen. Je kunt aangepaste CSS toevoegen als je meer controle over het ontwerp wilt.

• Schrijf aanvullende handleidingen met de editor. Deze pagina’s leggen concepten uit die verder gaan dan de automatische referentiepagina’s.

• Test je API-eindpunten met de ingebouwde client. Klik op een eindpunt, voeg parameters toe en verstuur verzoeken om echte reacties te zien.

• Deel je documentatie met je team of maak deze openbaar. Je kunt machtigingen instellen om te bepalen wie kan bewerken of bekijken.

• Prachtige API-documentatie van OpenAPI-bestanden

• Ingebouwde testing met API-client

• GitHub-integratie en automatische synchronisatie

• Aangepaste domeinen en thema's

• Framework-integraties voor alle grote platforms

• TypeSense-aangedreven zoekfunctie

• Ondersteuning voor meerdere API-versies

• Markdown- en MDX-gidsen

• Team samenwerkingshulpmiddelen

• Open-source en zelf te hosten

• Gratis subdomein inbegrepen

• Ondersteuning voor aangepaste CSS en JavaScript