mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-25 18:13:44 +03:00
b604bd8da8
* fix: exclusiveMin/Max shows incorect range * cover all number range cases & add unit tests * add more tests * fix maximum value * simplify humanizeNumberRange function * simplify exclusive checks * Update src/utils/openapi.ts Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com> * update test coverage * linting * revert weird prettier changes * add md files to prettier ignore Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
1.6 KiB
1.6 KiB
| title |
|---|
| Redoc quickstart guide |
Redoc quickstart guide
To render your OpenAPI definition using Redoc, use the following HTML code sample and
replace the spec-url attribute with the URL or local file address to your definition.
<!DOCTYPE html>
<html>
<head>
<title>Redoc</title>
<!-- needed for adaptive design -->
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link
href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
rel="stylesheet"
/>
<!--
Redoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<!--
Redoc element with link to your OpenAPI definition
-->
<redoc spec-url="http://petstore.swagger.io/v2/swagger.json"></redoc>
<!--
Link to Redoc JavaScript on CDN for rendering standalone element
-->
<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"></script>
</body>
</html>
:::attention Running Redoc locally requires an HTTP server Loading local OpenAPI definitions is impossible without running a web server because of issues with same-origin policy and other security reasons. Refer to Running Redoc locally for more information. :::
For a more detailed explanation with step-by-step instructions and additional options for using Redoc, refer to the Redoc deployment guide.