2.5.5 • Published 7 months ago

@scalar/api-client v2.5.5

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

Scalar API Client

Version Downloads License Discord

The Scalar API Client is a powerful tool designed to simplify API testing and integration. This versatile package offers multiple usage options:

  • standalone application for quick and easy API testing
  • embeddable component in various frontend environments
  • customizable module that can be integrated into existing projects

Features

  • Intuitive interface for sending API requests and viewing responses
  • Support for multiple authentication methods
  • Real-time request/response logging
  • Customizable request headers and parameters
  • Response visualization and formatting options

Installation

npm install @scalar/api-client

Usage

App

You can mount the full-blown API Client to your DOM like this:

<!-- index.html -->
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1.0" />
    <title>Scalar API Client App</title>
  </head>
  <body>
    <div
      id="scalar-client"
      class="scalar-app scalar-client"></div>
    <script
      type="module"
      src="./main.js"></script>
  </body>
</html>
// main.js
import { createApiClientApp } from '@/App'

// Initialize
await createApiClientApp(document.getElementById('scalar-client'), {
  url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
  proxyUrl: 'https://proxy.scalar.com',
})

Modal

Or you can mount a more compact version, which is living in a modal:

// main.js
import { createApiClientApp } from '@/App'

// Initialize
const { open } = await createApiClientApp(
  document.getElementById('scalar-client'),
  {
    url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
    proxyUrl: 'https://proxy.scalar.com',
  },
)

// Open the API client right-away
open()

// Or: Open a specific operation
// open({
//   method: 'GET',
//   path: '/me',
// })

Configuration

/** Configuration options for the Scalar API client */
export type ClientConfiguration = {
  /** The Swagger/OpenAPI document to render */
  spec: SpecConfiguration
  /** Pass in a proxy to the API client */
  proxyUrl?: string
  /** Pass in a theme API client */
  themeId?: string
  /** Whether to show the sidebar */
  showSidebar?: boolean
  /** Whether dark mode is on or off initially (light mode) */
  // darkMode?: boolean
  /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
  searchHotKey?:
    | 'a'
    | 'b'
    | 'c'
    | 'd'
    | 'e'
    | 'f'
    | 'g'
    | 'h'
    | 'i'
    | 'j'
    | 'k'
    | 'l'
    | 'm'
    | 'n'
    | 'o'
    | 'p'
    | 'q'
    | 'r'
    | 's'
    | 't'
    | 'u'
    | 'v'
    | 'w'
    | 'x'
    | 'y'
    | 'z'
}

Available Methods

The following methods are returned from the createApiClientModal call:

open

Opens the modal while allowing you to select which request to open to

open({ path: string; method: RequestMethod })

updateConfig

Allows you to update the config at any time, this will clear your current state and re-import a fresh spec!

updateConfig(newConfig: ClientConfiguration, mergeConfigs?: boolean): void

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.

apiclientgraphqlpostman alternativeresttesting
@headlessui/tailwindcss@headlessui/vue@vueuse/core@vueuse/integrationsfocus-trapfuse.jsmicrodiffnanoidpretty-bytespretty-msshell-quotetype-festvuevue-routerwhatwg-mimetypeyamlzod@scalar/components@scalar/draggable@scalar/import@scalar/helpers@scalar/oas-utils@scalar/icons@scalar/openapi-parser@scalar/openapi-types@scalar/postman-to-openapi@scalar/snippetz@scalar/themes@scalar/types@scalar/object-utils@scalar/use-hooks@scalar/use-toasts@scalar/use-codemirror@scalar/use-tooltip
@everything-registry/sub-chunk-810flow-devlopdocbunny_devlopdoc@scalar/api-client-react@scalar/api-reference@scalar/api-reference-editor@scalar/nuxt@scalar/play-button
2.4.1

7 months ago

2.4.3

7 months ago

2.4.2

7 months ago

2.4.4

7 months ago

2.5.5

7 months ago

2.3.2

10 months ago

2.3.1

10 months ago

2.3.4

10 months ago

2.3.3

10 months ago

2.3.6

10 months ago

2.3.5

10 months ago

2.2.1

1 year ago

2.2.0

1 year ago

2.2.3

1 year ago

2.2.2

1 year ago

2.2.4

1 year ago

2.2.7

1 year ago

2.2.6

1 year ago

2.3.8

9 months ago

2.3.7

10 months ago

2.3.9

9 months ago

2.2.9

1 year ago

2.2.8

1 year ago

2.2.17

1 year ago

2.1.49

1 year ago

2.2.18

1 year ago

2.2.15

1 year ago

2.1.47

1 year ago

2.2.16

1 year ago

2.1.48

1 year ago

2.1.45

1 year ago

2.1.46

1 year ago

2.2.11

1 year ago

2.1.43

1 year ago

2.2.12

1 year ago

2.1.44

1 year ago

2.2.10

1 year ago

2.1.42

1 year ago

2.2.19

1 year ago

2.2.28

1 year ago

2.2.29

12 months ago

2.2.26

1 year ago

2.2.27

1 year ago

2.2.24

1 year ago

2.2.25

1 year ago

2.2.22

1 year ago

2.2.23

1 year ago

2.2.20

1 year ago

2.1.52

1 year ago

2.2.21

1 year ago

2.1.50

1 year ago

2.1.51

1 year ago

2.2.39

11 months ago

2.5.0

7 months ago

2.2.37

11 months ago

2.2.38

11 months ago

2.5.2

7 months ago

2.2.35

12 months ago

2.5.1

7 months ago

2.5.4

7 months ago

2.2.33

12 months ago

2.5.3

7 months ago

2.2.34

12 months ago

2.2.31

12 months ago

2.2.32

12 months ago

2.2.30

12 months ago

2.3.17

9 months ago

2.3.16

9 months ago

2.3.19

9 months ago

2.2.48

11 months ago

2.3.18

9 months ago

2.2.49

10 months ago

2.3.13

9 months ago

2.3.12

9 months ago

2.2.47

11 months ago

2.3.15

9 months ago

2.2.44

11 months ago

2.3.14

9 months ago

2.2.45

11 months ago

2.2.42

11 months ago

2.2.43

11 months ago

2.3.11

9 months ago

2.2.40

11 months ago

2.3.10

9 months ago

2.2.41

11 months ago

2.3.28

8 months ago

2.3.27

8 months ago

2.2.59

10 months ago

2.3.29

8 months ago

2.3.24

8 months ago

2.2.57

10 months ago

2.3.23

9 months ago

2.3.26

8 months ago

2.2.55

10 months ago

2.3.25

8 months ago

2.2.56

10 months ago

2.3.20

9 months ago

2.2.53

10 months ago

2.2.54

10 months ago

2.3.22

9 months ago

2.2.51

10 months ago

2.3.21

9 months ago

2.2.52

10 months ago

2.2.50

10 months ago

2.3.34

8 months ago

2.3.31

8 months ago

2.3.30

8 months ago

2.3.33

8 months ago

2.2.62

10 months ago

2.3.32

8 months ago

2.2.60

10 months ago

2.2.61

10 months ago

2.1.41

1 year ago

2.1.40

1 year ago

2.1.38

1 year ago

2.1.39

1 year ago

2.1.36

1 year ago

2.1.37

1 year ago

2.1.35

1 year ago

2.1.34

1 year ago

2.1.33

1 year ago

2.1.32

1 year ago

2.1.27

1 year ago

2.1.28

1 year ago

2.1.25

1 year ago

2.1.26

1 year ago

2.1.24

1 year ago

2.1.29

1 year ago

2.1.30

1 year ago

2.1.31

1 year ago

2.1.23

1 year ago

2.1.22

1 year ago

2.1.8

1 year ago

2.1.9

1 year ago

2.1.16

1 year ago

2.1.17

1 year ago

2.1.14

1 year ago

2.1.15

1 year ago

2.1.12

1 year ago

2.1.13

1 year ago

2.1.10

1 year ago

2.1.11

1 year ago

2.1.18

1 year ago

2.1.19

1 year ago

2.1.21

1 year ago

2.1.20

1 year ago

2.1.2

1 year ago

2.1.1

1 year ago

2.1.4

1 year ago

2.1.6

1 year ago

2.1.5

1 year ago

2.1.7

1 year ago

2.1.0

1 year ago

2.0.64

1 year ago

2.0.63

1 year ago

2.0.62

1 year ago

1.3.13

2 years ago

1.3.14

2 years ago

1.3.11

2 years ago

1.3.12

2 years ago

1.3.18

2 years ago

1.3.15

2 years ago

1.3.16

2 years ago

1.3.19

2 years ago

1.3.20

2 years ago

1.3.7

2 years ago

1.3.6

2 years ago

1.3.5

2 years ago

1.3.4

2 years ago

1.3.3

2 years ago

1.3.2

2 years ago

1.3.1

2 years ago

1.3.0

2 years ago

2.0.15

1 year ago

2.0.16

1 year ago

2.0.13

1 year ago

2.0.14

1 year ago

2.0.11

1 year ago

2.0.12

1 year ago

2.0.10

1 year ago

2.0.19

1 year ago

2.0.17

1 year ago

2.0.18

1 year ago

2.0.26

1 year ago

2.0.27

1 year ago

2.0.24

1 year ago

2.0.25

1 year ago

2.0.22

1 year ago

2.0.20

1 year ago

2.0.21

1 year ago

1.2.34

2 years ago

1.2.35

2 years ago

1.2.32

2 years ago

1.2.33

2 years ago

1.2.38

2 years ago

1.2.39

2 years ago

1.2.36

2 years ago

1.2.37

2 years ago

2.0.28

1 year ago

2.0.29

1 year ago

2.0.37

1 year ago

2.0.3

2 years ago

2.0.38

1 year ago

2.0.2

2 years ago

2.0.35

1 year ago

2.0.5

2 years ago

2.0.36

1 year ago

2.0.4

2 years ago

2.0.33

1 year ago

2.0.7

1 year ago

2.0.34

1 year ago

2.0.6

1 year ago

2.0.31

1 year ago

2.0.32

1 year ago

2.0.8

1 year ago

2.0.30

1 year ago

2.0.1

2 years ago

2.0.0

2 years ago

2.0.39

1 year ago

2.0.48

1 year ago

2.0.49

1 year ago

2.0.46

1 year ago

2.0.47

1 year ago

2.0.44

1 year ago

2.0.45

1 year ago

2.0.42

1 year ago

1.3.9

2 years ago

2.0.43

1 year ago

1.3.8

2 years ago

2.0.40

1 year ago

2.0.41

1 year ago

2.0.59

1 year ago

2.0.57

1 year ago

2.0.58

1 year ago

2.0.55

1 year ago

2.0.56

1 year ago

2.0.53

1 year ago

2.0.54

1 year ago

2.0.51

1 year ago

2.0.52

1 year ago

2.0.50

1 year ago

2.0.60

1 year ago

1.2.30

2 years ago

1.2.31

2 years ago

1.2.29

2 years ago

1.2.27

2 years ago

1.2.28

2 years ago

1.2.25

2 years ago

1.2.26

2 years ago

1.2.24

2 years ago

1.2.23

2 years ago

1.2.22

2 years ago

1.2.21

2 years ago

1.2.19

2 years ago

1.2.20

2 years ago

1.2.17

2 years ago

1.2.18

2 years ago

1.2.16

2 years ago

1.2.12

2 years ago

1.2.11

2 years ago

1.2.10

2 years ago

1.2.9

2 years ago

1.2.8

2 years ago

1.2.7

2 years ago

1.2.6

2 years ago

1.2.5

2 years ago

1.2.4

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.16

2 years ago

1.1.15

2 years ago

1.1.14

2 years ago

1.1.13

2 years ago

1.1.12

2 years ago

1.1.11

2 years ago

1.1.10

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.1

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.0

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.12.18

2 years ago

0.12.17

2 years ago

0.12.16

2 years ago

0.12.15

2 years ago

0.12.14

2 years ago

0.12.13

2 years ago

0.12.12

2 years ago

0.12.10

2 years ago

0.12.11

2 years ago

0.12.7

2 years ago

0.12.8

2 years ago

0.12.9

2 years ago

0.12.3

2 years ago

0.12.4

2 years ago

0.12.5

2 years ago

0.12.6

2 years ago

0.12.2

2 years ago

0.12.1

2 years ago

0.12.0

2 years ago

0.11.2

2 years ago

0.11.3

2 years ago

0.11.4

2 years ago

0.11.5

2 years ago

0.11.0

2 years ago

0.11.1

2 years ago

0.10.2

2 years ago

0.10.1

2 years ago

0.10.0

2 years ago

0.9.4

2 years ago

0.9.3

2 years ago

0.9.2

2 years ago

0.9.1

2 years ago

0.8.9

2 years ago

0.9.0

2 years ago

0.8.10

2 years ago

0.8.8

2 years ago

0.8.7

2 years ago

0.8.5

2 years ago

0.8.4

2 years ago

0.8.6

2 years ago

0.8.3

2 years ago

0.8.2

2 years ago

0.8.1

2 years ago

0.8.0

2 years ago

0.7.37

2 years ago

0.7.36

2 years ago

0.7.35

2 years ago

0.7.34

2 years ago

0.7.33

2 years ago

0.7.32

2 years ago

0.7.31

2 years ago

0.7.30

2 years ago

0.7.29

2 years ago

0.7.28

2 years ago

0.7.27

2 years ago

0.7.26

2 years ago

0.7.25

2 years ago

0.7.24

2 years ago

0.7.23

2 years ago

0.7.22

2 years ago

0.7.21

2 years ago

0.7.20

2 years ago

0.7.19

2 years ago

0.7.18

2 years ago

0.7.17

2 years ago

0.7.16

2 years ago

0.7.15

2 years ago

0.7.14

2 years ago

0.7.13

2 years ago

0.7.12

2 years ago

0.7.11

2 years ago

0.7.10

2 years ago

0.7.9

2 years ago

0.7.8

2 years ago

0.7.5

2 years ago

0.7.4

2 years ago

0.7.3

2 years ago

0.7.2

2 years ago

0.7.1

2 years ago

0.7.0

2 years ago

0.6.0

2 years ago

0.5.5

2 years ago

0.5.4

2 years ago

0.5.3

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.5.0

2 years ago

0.4.0

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.21

2 years ago

0.1.20

2 years ago

0.1.19

2 years ago

0.1.18

2 years ago

0.1.17

2 years ago

0.1.16

2 years ago

0.1.15

2 years ago

0.1.14

2 years ago

0.1.13

2 years ago

0.1.12

2 years ago

0.1.11

2 years ago

0.1.10

2 years ago

0.1.9

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago