Bewerk, valideer en test OpenAPI-documenten
De OpenAPI-specificatie (OAS) is een standaard die web-API's beschrijft in een formaat dat onafhankelijk is van programmeertalen. Het creƫert een blauwdruk die uitlegt hoe softwaretoepassingen met elkaar communiceren via het internet. Ontwikkelaars gebruiken OpenAPI om instructies in JSON of YAML te schrijven die details over de API beschrijven, zoals eindpunten, data en beveiligingsaspecten. Deze gestandaardiseerde beschrijving maakt het mogelijk voor andere programma's om met de API te communiceren zonder de interne code te hoeven bekijken.
XMLSpy bevat intelligente tools voor het werken met OpenAPI tijdens de ontwikkeling of het ontdekken ervan, waaronder validatie, bewerking en testen.
De grafische JSON Schema Editor in XMLSpy ondersteunt het valideren en bewerken van JSON-schema's op basis van de OAS (OpenAPI Specification). De visuele interface maakt het voor ontwikkelaars eenvoudiger om met complexe OpenAPI-schema's te werken, doordat deze een grafische weergave van de structuur biedt, waardoor het gemakkelijker is om de structuur te begrijpen en fouten of inconsistenties te identificeren.
De JSON Schema-editor biedt ondersteuning voor OAS-extensies, waaronder discriminator, XML, format en externe documentatie, die geconfigureerd kunnen worden via de "Details"-hulpfunctie.
Of uw OpenAPI-document is geschreven in JSON of YAML, de tekstgebaseerde OpenAPI-editor in XMLSpy biedt intelligente bewerkingsfuncties, zoals syntaxismarkering, codeopvouwen, automatische aanvulling en hulpmiddelen voor het invoeren van gegevens.
Als u overschakelt naar de rasterweergave, biedt XMLSpy een grafische weergave van de documentstructuur, waardoor het gemakkelijker wordt om te navigeren, te begrijpen en te bewerken. Naast intelligente bewerkingstools, biedt de rasterweergave opdrachten binnen de cellen, visuele bewerking door slepen en neerzetten, en een tabelweergave om de manier waarop knooppunten worden weergegeven, te wijzigen. U kunt ook secties van de gegevens uitvouwen en inklappen om door lange bestanden te navigeren en specifieke elementen te lokaliseren.
Zowel de tekstweergave als de rasterweergave bieden validatie van documenten op basis van de OpenAPI-specificatie.
Bij het beginnen vanaf nul, bevat XMLSpy ingebouwde sjablonen voor het maken van nieuwe OpenAPI-documenten, met ondersteuning voor Open API 1.0, 2.0 en 3.0.
XMLSpy bevat een handige "HTTP-testvenster met ondersteuning voor OpenAPI. Dit venster begeleidt u bij het maken en verzenden van een HTTP-verzoek naar een bestaande API. Vervolgens kunt u de reactie direct in het venster ontvangen, controleren en eventuele problemen oplossen.
Zodra u de locatie van het OpenAPI-document heeft opgegeven, toont het venster voor HTTP-testen de beschikbare paden met de bijbehorende bewerkingen.
Op basis van de instellingen en parameters die u selecteert voor de test, genereert XMLSpy automatisch het testbericht, dat u naar de API kunt sturen. Vervolgens kunt u de resultaten bekijken.
Het vermogen om verzoeken te versturen en antwoorden te bekijken zorgt ervoor dat de API zich tijdens de ontwikkeling en integratie gedraagt zoals verwacht. Het is een effectief hulpmiddel om uw eigen API's te testen, maar ook om de interfaces van derden te verkennen.



