Comments (13)
Thx.
Yes, the whole Swagger Model/Definitions rendering must be refined in swagger2markup.
from swagger2markup.
+1 vote for this feature.
from swagger2markup.
+1
from swagger2markup.
Hi sry. I have much to do at work.
I hope I will have time soon.
PRs welcome ;-)
from swagger2markup.
Fixed in Version 0.2.3
from swagger2markup.
Thanks for the update. I tried the updated code and see that that there are now links to definitions in the Responses table. However the links are to anchors in the same file, while the Definitions appear to be a separate file.
from swagger2markup.
Thx. @yzatslinear I would like to know your opinion. Do you think it even makes sense to create separate files or would you prefer one file.
As a workaround you can use the method asString(). See readme example. And use Asciidoctorj directly.
from swagger2markup.
I think a single file would be OK -- I'm not aware of any limitations this would present.
from swagger2markup.
@yzatslinear The approach with two files is to create an index.adoc which contains:
:doctype: book
:toc: left
:toclevels: 2
:numbered:
:sectlinks:
:sectanchors:
include::paths.adoc[]
include::definitions.adoc[]
and run AsciiDcotorJ (or the Gradle plugin). See build.gradle file as an example:
asciidoctor {
sources {
include 'index.adoc'
}
backends = ['html5', 'pdf']
attributes = [
doctype: 'book',
toc: 'left',
toclevels: '2',
numbered: ''
]
}
The anchors in HTML work then. Unfortunately PDF seems to have a problem. This must be a bug in org.asciidoctor:asciidoctorj-pdf
I will include the index.adoc in version 0.2.4
from swagger2markup.
I created an issue regarding the PDF issue.
asciidoctor/asciidoctorj#290
from swagger2markup.
Thanks @RobWin,
You say above that you include index.adoc into 0.2.4, but it doesn't appear it made it in ?
from swagger2markup.
The index.adoc is in /src/docs/asciidoc/
If you run the Gradle asciidoctor task, it creates an index.html in /build/asciidoc
The index.doc is not created automatically, because this concept does not exists in Markdown.
from swagger2markup.
Ah, makes sense. Thanks!
from swagger2markup.
Related Issues (20)
- OpenApi 3.0 to Markdown output
- OpenApi 3.0 descriptions to be converted valid asciidoc
- I hope converting to .doc HOT 2
- Paths Index HOT 8
- Wrong JSON for response example
- No new release since April 2018 ... is the project abandoned? HOT 10
- 能否折叠表格? HOT 1
- StackOverflow when examples have cyclic references #173
- swagger2markup.extensions.dynamicDefinitions.contentPath not working in swagger2markup 2.0.0 snapshot
- null values are cleaned out in adoc
- JCenter is Gone
- Swagger v3 cannot use swagger2markup(1.3.3) HOT 1
- About @Tags HOT 1
- Can we implement this swagger2markup with swagger 3 ?
- Remove dependency on pegdown HOT 4
- swagger2markup-cli 1.3.4 jar is missing in maven central HOT 8
- Latest JAR library on https://mvnrepository.com/ doesn't include OpenAPI classes HOT 4
- Grouping by TAG for OpenAPI v3.0 is ignored
- QA: does support springdoc-openapi-ui ?
- END Header Not Found on internal dependencies paleo-core and asciidoc
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swagger2markup.