apiuikit 1.5.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/dist/{CodeSamples-BTbc5r5x.js → CodeSamples-3fEAwC7U.js} +894 -908
- package/dist/CodeSamples-CtJp4xci.cjs +50 -0
- package/dist/LogoExtension-Cg0OHsOO.cjs +1 -0
- package/dist/LogoExtension-DBlTRKT3.js +17 -0
- package/dist/apiuikit.cjs.js +1 -1
- package/dist/apiuikit.css +1 -1
- package/dist/apiuikit.es.js +16 -15
- package/dist/components/DocumentTopBar.d.ts +13 -0
- package/dist/components/InfoMetadata.d.ts +1 -1
- package/dist/components/MarkdownExportMenu.d.ts +2 -4
- package/dist/components/SearchPanel.d.ts +2 -1
- package/dist/components/Section.d.ts +2 -0
- package/dist/config/config.d.ts +11 -0
- package/dist/containers/AsyncAPI/AsyncAPIDocumentProvider.d.ts +1 -1
- package/dist/containers/Information/Information.d.ts +1 -0
- package/dist/containers/Information/InformationSection.d.ts +9 -1
- package/dist/containers/Information/OpenAPIInformation.d.ts +2 -1
- package/dist/containers/OpenAPI/OpenAPIDocumentProvider.d.ts +1 -1
- package/dist/contexts/useSpec.d.ts +5 -1
- package/dist/helpers/markdownForLlm.d.ts +7 -0
- package/dist/hooks/useDocumentProviderValue.d.ts +2 -0
- package/dist/{index-B56IGsKQ.cjs → index-BBQWVHuB.cjs} +1 -1
- package/dist/{index-C1wJpOpO.js → index-BQeCkb1z.js} +1 -1
- package/dist/index-C2kuzQch.cjs +180 -0
- package/dist/{index-SjuDObn0.cjs → index-Cp1PIb8-.cjs} +1 -1
- package/dist/{index-B_FmNLVS.js → index-DS1UYBq6.js} +3848 -3749
- package/dist/{index-BqoxEOEn.js → index-DuK6tYTi.js} +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/markdown.cjs +16 -13
- package/dist/markdown.d.ts +1 -0
- package/dist/markdown.es.js +201 -189
- package/dist/{protoToJsonSchema-BE53lwwY.cjs → protoToJsonSchema-DehbDBi4.cjs} +1 -1
- package/dist/{protoToJsonSchema-DuD3V4uf.js → protoToJsonSchema-lLl_CPoQ.js} +1 -1
- package/dist/{protobufSchemaParser-SgDax0hE.cjs → protobufSchemaParser-5IiEfmHU.cjs} +1 -1
- package/dist/{protobufSchemaParser-DYXXb9bI.js → protobufSchemaParser-Cmr_zqRL.js} +2 -2
- package/dist/utils/scrollLock.d.ts +6 -0
- package/package.json +3 -2
- package/dist/CodeSamples-DnUDjxCK.cjs +0 -50
- package/dist/LogoExtension-BOYrY_RE.cjs +0 -1
- package/dist/LogoExtension-HOlSsQf-.js +0 -27
- package/dist/index-Cb-MitPO.cjs +0 -177
package/README.md
CHANGED
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
# apiuikit
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/apiuikit)
|
|
3
|
+
[](https://www.npmjs.com/package/apiuikit)
|
|
4
4
|
[](https://www.npmjs.com/package/apiuikit)
|
|
5
5
|
[](https://www.npmjs.com/package/@apiuikit/web-component)
|
|
6
6
|
[](./LICENSE)
|
|
7
7
|
|
|
8
8
|
React component library for rendering API specifications. Point it at an AsyncAPI or OpenAPI document and get a full interactive UI, which includes: servers, channels/endpoints, operations, messages, schemas, with no manual mapping required.
|
|
9
9
|
|
|
10
|
-
> **
|
|
11
|
-
>
|
|
10
|
+
> **Spec compatibility:** apiuikit renders AsyncAPI 3.x and OpenAPI 3.0/3.1
|
|
11
|
+
> documents. Version compatibility does not imply that every specification
|
|
12
|
+
> keyword has a dedicated UI; see [OpenAPI coverage](./docs/usage/openapi.md#coverage)
|
|
13
|
+
> for the exact rendered features and deliberate limits.
|
|
12
14
|
|
|
13
15
|
## Install
|
|
14
16
|
|
|
@@ -98,7 +100,8 @@ See the full usage docs for props, configuration options, and more:
|
|
|
98
100
|
- [Without Parser](./docs/usage/no-parser.md) (`AsyncAPI` component)
|
|
99
101
|
- [With Parser](./docs/usage/with-parser.md) (`AsyncAPIRenderer` component, `parseAndRender` utility)
|
|
100
102
|
- [Composable Sections](./docs/usage/sections.md) (`Servers`, `Operations`, `Messages`, `Schemas`, `Info`, `AsyncAPIProvider`)
|
|
101
|
-
- [
|
|
103
|
+
- [Configuration](./docs/configuration/config.md) (`ConfigInterface`: theme, show flags, sidebar, sidePanel, etc.)
|
|
104
|
+
- [Web Components](./docs/usage/with-webcomponents.md) (`<apiuikit-asyncapi>`, `<apiuikit-asyncapi-renderer>`, use apiuikit from any framework)
|
|
102
105
|
- [Markdown export](./docs/usage/markdown-export.md) (making your docs AI-readable: `config.markdown.url`, `documentToMarkdown`, `documentToLlmsTxt`)
|
|
103
106
|
- [Avro schemas](./docs/usage/avro.md)
|
|
104
107
|
- [Protobuf schemas](./docs/usage/protobuf.md)
|
|
@@ -115,7 +118,7 @@ npm install @apiuikit/web-component
|
|
|
115
118
|
Load the custom elements and stylesheet once, then pass a raw AsyncAPI or OpenAPI document to the corresponding renderer:
|
|
116
119
|
|
|
117
120
|
```html
|
|
118
|
-
<
|
|
121
|
+
<apiuikit-asyncapi-renderer id="api-doc"></apiuikit-asyncapi-renderer>
|
|
119
122
|
```
|
|
120
123
|
|
|
121
124
|
```js
|
|
@@ -126,7 +129,7 @@ const apiDoc = document.querySelector("#api-doc");
|
|
|
126
129
|
apiDoc.spec = rawYamlOrJsonString;
|
|
127
130
|
```
|
|
128
131
|
|
|
129
|
-
Use `<
|
|
132
|
+
Use `<apiuikit-openapi-renderer>` for raw OpenAPI documents. If the document is already parsed, use `<apiuikit-asyncapi>` or `<apiuikit-openapi>` and assign the object to its `spec` property.
|
|
130
133
|
|
|
131
134
|
See [Web Components](./docs/usage/with-webcomponents.md) for CDN usage, configuration, diagnostics, and framework integration.
|
|
132
135
|
|