search

zalando-incubator / hexo-theme-doc

A documentation theme for the Hexo blog framework
https://zalando-incubator.github.io/hexo-theme-doc
Other
250 stars 56 forks source link

Update to Swagger 3.0 #160

Open itpropro opened 5 years ago

itpropro commented 5 years ago

I would like to use this theme as a documentation platform internally. The problem is that we internally as well as all our customers are using OpenAPI 3.0.

Expected Behavior

Use OpenAPI 3.0 yaml file as input for swagger_to_html and swagger_ui and see the redered UI/HTML on the website

Actual Behavior

Unhandled rejection Template render error: (unknown path) SyntaxError: C:\repos\docs\source\swagger\example.yaml is not a valid Swagger API definition ...

Steps to Reproduce the Problem

  1. Create a working hexo instance by cloning the example repo
  2. Create a valid OpenAPI 3.0 file
  3. Create a new page and use the provided tag plugins to reference the example file

Specifications

rbarilani commented 5 years ago

@itpropro For swagger-ui I think we should be able to have an easy fix, for the custom generator it's a little bit trickier since we have to update the way the we parse and transform the output to markdown/html (ping @bhaskarmelkani). @itpropro any chance that you contribute and help us out on this issue?