@estos/esnacc-openapi-sdk
v1.0.16
Published
Fancy frontend for showing and testing openapi schemas derived from asn1 files created trough esnacc
Downloads
19
Readme
esnacc-openapi-sdk
Fancy frontend for showing and testing openapi schemas derived from asn1 files created trough esnacc.
Testing
If you want to test the example clone this repo and execute:
npm run dev
In this repo there is no server to test te actual calls. If you want to also test those, then look here.
Usage
Usage is pretty simple:
import SDK from "@estos/esnacc-openapi-sdk";
SDK({
// Id from the node where to render the SDK
domId: "ui",
// Schemas to load
schemas: [
{
// Url of the schema
schemaUrl: "/schema/ENetUC_Settings_Manager.json",
// Label to show (if not provided shows url)
label: "ENetUC_Settings_Manager",
// Inject things into the OpenApi Schema loaded from the url (Reference: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#serverObject)
"injectSpec": {
servers: [
{
"url": "ws://localhost:3020/ws"
},
{
"url": "http://localhost:3020/rest"
}
]
},
}
]
})There is also a bundled version that sets EsnaccOpenApiSDK on window.
You can use it like below:
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>MicroService Test Client</title>
<link rel="stylesheet" href="https://unpkg.com/@estos/esnacc-openapi-sdk/dist/esnacc-openapi-sdk.css" />
</head>
<body>
<div id="ui"></div>
<script type="text/javascript" href="https://unpkg.com/@estos/esnacc-openapi-sdk/dist/esnacc-openapi-sdk.js"></script>
<script type="module">
import SDK from "https://unpkg.com/@estos/esnacc-openapi-sdk/dist/esnacc-openapi-sdk.js"
SDK({
domId: "ui", schemas: [
{ schemaUrl: "/schema/ENetUC_Common.json", label: "ENetUC_Common" },
{
schemaUrl: "/schema/ENetUC_Settings_Manager.json", label: "ENetUC_Settings_Manager", "injectSpec": {
servers: [
{
"url": "ws://localhost:3020/ws"
},
{
"url": "http://localhost:3020/rest"
}
]
},
},
{
schemaUrl: "/schema/ENetUC_Event_Manager.json", label: "ENetUC_Event_Manager", "injectSpec": {
servers: [
{
"url": "ws://localhost:3020/ws"
},
{
"url": "http://localhost:3020/rest"
}
]
},
},
]
})
</script>
</body>
</html>