Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@scalar/swagger-editor

scalar2.5kMIT1.0.2TypeScript support: included

an editor which is tailored to write OpenAPI spec

api, editor, openapi, openapi, spec, swagger

readme

Scalar Swagger Editor

Version Downloads License Discord

Installation

npm install @scalar/swagger-editor

Usage

<script setup>
import { SwaggerEditor } from '@scalar/swagger-editor'
</script>

<template>
  <SwaggerEditor value="{ … }" />
</template>

changelog

@scalar/swagger-editor

1.0.2

Patch Changes

1.0.1

Patch Changes

1.0.0

Minor Changes

  • 7fb8273: Migrate to @scalar/openapi-parser

Patch Changes

0.11.3

Patch Changes

0.11.2

Patch Changes

  • ddc9b17: fix: re-added moving the components css into js so importing the css file is no longer needed
  • 775646a: fix: removed extra copy of vue from themes and some dependencies
  • ef3a015: chore: update to typescript 5.4
  • Updated dependencies [ddc9b17]
  • Updated dependencies [775646a]
  • Updated dependencies [ef3a015]

0.11.1

Patch Changes

0.11.0

Minor Changes

  • ad2b95a: fix: scope scrollbar styles
  • ad2b95a: refactor: move reset component to themes package

Patch Changes

0.10.15

Patch Changes

0.10.14

Patch Changes

0.10.13

Patch Changes

0.10.12

Patch Changes

0.10.11

Patch Changes

0.10.10

Patch Changes

0.10.9

Patch Changes

0.10.8

Patch Changes

0.10.7

Patch Changes

0.10.6

Patch Changes

0.10.5

Patch Changes

0.10.4

Patch Changes

  • cb8139e7: fix: rollback api client proxy and request changes

0.10.3

Patch Changes

0.10.2

Patch Changes

0.10.1

Patch Changes

0.10.0

Minor Changes

  • 612431b4: Migrate model logic from codemirror component to hook

Patch Changes

0.9.12

Patch Changes

  • 04c0bd9b: chore: remove unused dependencies

0.9.11

Patch Changes

0.9.10

Patch Changes

0.9.9

Patch Changes

0.9.8

Patch Changes

0.9.7

Patch Changes

0.9.6

Patch Changes

  • 5ca138ee: - Removed activeBreadCrumb from api-client as its available in the slot
    • Centralized navigation logic
    • use proper anchor navigation instead of scrollIntoView, it will also be saved to history
    • scrolling down will open the next section
  • Updated dependencies [5ca138ee]

0.9.5

Patch Changes

  • 6cc43ab7: fix: reset body margin

0.9.4

Patch Changes

0.9.3

Patch Changes

0.9.2

Patch Changes

  • 0b66933d: fix: declare theme font for buttons and fix regressed font weight

0.9.1

Patch Changes

0.9.0

Minor Changes

  • 1972947f: chore: removed yjs and hocus pocus from swagger editor

0.8.4

Patch Changes

0.8.3

Patch Changes

  • f9bfa97: feat: add buttons to header for classic layout

0.8.2

Patch Changes

  • 4f2fcc3: refactor: simplify and expand css reset

0.8.1

Patch Changes

  • 98e01a2: fix: prevent css leakage from references reset
  • c04c2ea: fix: move swagger editor title down to cover border

0.8.0

Minor Changes

  • f38bb61: chore: remove swagger editor tabs

Patch Changes

0.7.11

Patch Changes

  • 2251ea5: chore: remove tableau example

0.7.10

Patch Changes

0.7.9

Patch Changes

0.7.8

Patch Changes

0.7.7

Patch Changes

  • 1a2afb6: fix: set additional peer dependency versions

0.7.6

Patch Changes

  • 8e65ba9: fix: set codemirror peer dependency version
  • 36761e4: feat: make the available tabs configurable

0.7.5

Patch Changes

  • b6552df: chore: externalize dependencies, optimize bundle size
  • 04875a6: fix: remove empty content update deleting rendered refs

0.7.4

Patch Changes

  • 801f1b5: feat: improve getting started page

0.7.3

Patch Changes

  • ff81f70: refactor: move getting started example to GettingStarted component
  • ff81f70: fix: don’t overwrite the CodeMirror content when collaborative editing is enabled

0.7.2

Patch Changes

  • f4681d5: feat: add yaml syntax highlighting
  • c92a3a3: chore: don’t add heading ids to the rendered Markdown
  • 48118ba: feat: add updateContent event to the ApiReference component
  • dab853a: chore: remove unused dependencies
  • Updated dependencies [f4681d5]
  • Updated dependencies [dab853a]

0.7.1

Patch Changes

  • a7e6c25: fix: externalize remark/rehype dependencies to fix SSG builds

0.7.0

Minor Changes

  • 440815a: Add getting started to empty render area

Patch Changes

  • 509db1e: refactor: move all api reference refs and watchers to hooks
  • a4f1b08: fix: switching documents with collaborative editing mode enabled
  • Updated dependencies [b0835a2]
  • Updated dependencies [509db1e]
  • Updated dependencies [a4f1b08]

0.6.30

Patch Changes

  • 8e2e4e5a: fix markdown collisions + prefix the card name

0.6.29

Patch Changes

  • db24e103: hotfix: import spec from url

0.6.28

Patch Changes

  • 2f0b2f01: refactor: improve the data flow between the reference and the swagger editor

0.6.27

Patch Changes

  • a73ee9d8: fix typography on editor headings

0.6.26

Patch Changes

  • d5fccba9: add ai writer to swagger editor

0.6.25

Patch Changes

0.6.24

Patch Changes

0.6.23

Patch Changes

  • d87566fd: refactor: new section components, new sidebar
  • Updated dependencies [db7f5f57]
  • Updated dependencies [d87566fd]
  • Updated dependencies [8be53df2]
  • Updated dependencies [4eaee866]
  • Updated dependencies [06b46553]

0.6.22

Patch Changes

  • 357a174d: feat: fix import URL, use proxy to fetch files
  • 357a174d: feat: click on import url or upload file in getting started opens the modal/dialog now
  • Updated dependencies [fd6cf1bb]

0.6.21

Patch Changes

0.6.20

Patch Changes

0.6.19

Patch Changes

0.6.18

Patch Changes

  • a7f776ba: fix: restore content from local storage

0.6.17

Patch Changes

  • eb0c3201: Lot's of small things + bigger temp fix for the multi content cards
  • Updated dependencies [eb0c3201]

0.6.16

Patch Changes

  • 3805e649: remove hover on active header tab

0.6.15

Patch Changes

0.6.14

Patch Changes

  • 99744358: feat: cache swagger editor content in local storage
  • 3dd2574d: sidebar toggle not flex aligned + fix folder colors

0.6.13

Patch Changes

0.6.12

Patch Changes

0.6.11

Patch Changes

  • 727d7f47: make swagger editor tab state controllable via prop
  • 727d7f47: add initial tab state prop to swagger editor

0.6.10

Patch Changes

0.6.9

Patch Changes

0.6.8

Patch Changes

0.6.7

Patch Changes

0.6.6

Patch Changes

  • cd5f2685: codemirror colors + font fixes throughout app
  • Updated dependencies [cd5f2685]

0.6.5

Patch Changes

0.6.4

Patch Changes

  • 5363374d: fix broken renderer for swagger editor

0.6.3

Patch Changes

0.6.2

Patch Changes

  • 75a69ba7: feat: add theme prop and improve theme support
  • d6a10e1f: fix: no border for the buttons
  • Updated dependencies [75a69ba7]
  • Updated dependencies [75a69ba7]

0.6.1

Patch Changes

  • b184bdf2: codemirror themeing and other theme fixes
  • 8751c874: Fix background color not being applied below rendered references
  • addd9fa2: feat: use default prefix for all CSS variables
  • 2006aa43: fix: add CSS reset
  • Updated dependencies [b184bdf2]
  • Updated dependencies [3b1fec80]
  • Updated dependencies [addd9fa2]

0.6.0

Minor Changes

  • 87fda5af: chore: update dependencies

Patch Changes

  • ef080a26: chore: format package.json
  • 45645710: feat: show number of connected users fix: typo, use API reference without Yjs chore: remove useSwaggerEditor, no more global state
  • Updated dependencies [ef080a26]
  • Updated dependencies [87fda5af]

0.5.6

Patch Changes

0.5.5

Patch Changes

0.5.4

Patch Changes

0.5.3

Patch Changes

  • a0a1590f: feat: make list of global extensions reactive

0.5.2

Patch Changes

0.5.1

Patch Changes

0.5.0

Minor Changes

  • 0902d82c: * feat: register custom CodeMirror extensions
    • feat: configure a status text to show in the Swagger editor
    • clean up: remove custom CSS to overwrite the CodeMirror themes

Patch Changes

0.4.0

Minor Changes

  • 5057e213: make npm packages public :-)

Patch Changes

0.3.0

Minor Changes

  • b0f5221: manually releasing all packages to make sure the lastest version is on npm

Patch Changes

0.2.0

Minor Changes

  • a ton of fixes, new fastify plugin

Patch Changes

0.1.16

Patch Changes

0.1.15

Patch Changes

  • add offline search and ui improvements
  • add offline search, improve ui
  • Updated dependencies
  • Updated dependencies

0.1.14

Patch Changes

0.1.13

Patch Changes

0.1.12

Patch Changes

0.1.11

Patch Changes

0.1.10

Patch Changes

0.1.9

Patch Changes

  • fix incorrect font sizes

0.1.8

Patch Changes

0.1.7

Patch Changes

  • fix: mismatched variables

0.1.6

Patch Changes

0.1.5

Patch Changes

0.1.4

Patch Changes

0.1.3

Patch Changes

0.1.2

Patch Changes

0.1.1

Patch Changes