Skip to content

README.md

Latest commit

 

History

History
36 lines (30 loc) · 1.19 KB

README.md

File metadata and controls

36 lines (30 loc) · 1.19 KB

Create a beatiful redoc or swagger specification for your scrapyd based API.

HOW-TO

Just add redoc.html to your scrapyd based API, and yoou will have an interactive scrapyd documentation. DEMO.

<!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 spec-url='https://raw.githubusercontent.com/zero0nee/scrapyd_openapi/master/open_api.yaml'></redoc>
    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
  </body>
</html>

CREDITS

This project has samply converted the official scrapyd documentation to openapi-spec format.