Comments (7)
Hi,
thanks for evaluating Swagger2Markup. I would love to get your GitHub Star in the Root Project, if you like it.
Have you already read the user guide: http://swagger2markup.github.io/swagger2markup/1.3.1/
It might answer some questions.
You can either add further information by including manual written Asciidoc/Markdown files to the index.adoc
files. See Gradle Template Project as an example. Or you can use the Dynamic file import extension (which is also shown in the Gradle Template Project) to add file content at specific extensions points.
You could also write your own custom extensions.
You could use a different tool than Springfox, which uses JavaDoc to generate your Swagger Spec.
from spring-swagger2markup-demo.
@RobWin Hi,
question of swagger.xlsx
Thanks very much for your answer.
What I want is not add including and extension, I want to reverse the Asciidoc which is generated.
Please check the attachment, which descripted my desire.
Add annotation in source code, can add the information I wanted.
But there is a lot of API, I need to copy same annotation everywhere.
I don’t want to do copy, want to merge the same annotation in one file, then I use some logic to add them to document.(JSON or Asciidoc).
I’m reading the document. Since I’m not native English speaker (I know you are neither ^^), would you please give me more hint on where is the code I can work on.
Best Regards
from spring-swagger2markup-demo.
And i want to know, if i have a springboot project with spingfox, how can i add Swagger2Markup to my project?
from spring-swagger2markup-demo.
Sry. But I won't open a xlsx file.
Please ask your questions in Markdown-format.
Swagger2Markup is just a Swagger YAML/JSON to Markdown/AsciiDoc converter.
The generation of a Swagger file from Source Code is out-of-scope. This is the scope of other projects like Springfox.
Please have a look at this demo project and our user guide to understand how to add Swagger2Markup to your SpringBoot application.
from spring-swagger2markup-demo.
@RobWin
Got it, that is fine.
My question is as below.
And if i want to save the json file which is created by springfox, i need to add a junit source code such as the demo, is this right?
from spring-swagger2markup-demo.
Again: You should ask these questions in the Springfox project.
As far as I know there is a PR which added this extension functionality in Springfox. See PR springfox/springfox#1254
See issue: springfox/springfox#1232
from spring-swagger2markup-demo.
How to add the code block when use Swagger2Markup to generate adoc file automatic?
from spring-swagger2markup-demo.
Related Issues (20)
- Gradle not running HOT 2
- pom.xml
- it looks we need many dependencies for the pom.xml HOT 1
- snippets not included HOT 4
- new package api not scanned
- Cannot use dedicated Spring profile for generating docs HOT 2
- Documentation not available when demo is started via gradle bootRun HOT 2
- SpringBoot not working HOT 9
- Will this work with Springfox > 2.7?
- build tasks not running
- Execution failed for task ':test'.
- could you tell me where you set the property `io.springfox.staticdocs.outputDir`
- Execute “mvn clean test” when dataType is date ,An error occurred
- Wrong path configuration property for snippets folder - maven
- JCenter is only available over HTTPS.
- Failed to execute goal io.github.swagger2markup:swagger2markup-maven-plugin
- Project not building HOT 2
- Pdf is not generated HOT 19
- PDF not generated - Maven HOT 12
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 spring-swagger2markup-demo.