swagger 2インタフェースをドキュメントドキュメントドキュメントタイプにエクスポートhtml pdf

今日はちょうどインタフェースのドキュメントを整理する必要があるので、swaggerでエクスポートできるかどうか、ネット上で先輩たちの資料を見てみると便利で、ここにも足跡を残して記憶しやすいと思います.まずswagger 2 markupを使用してadocドキュメントをエクスポートするには、導入に依存する必要があります.この間、jarパッケージの衝突の問題にも関連する可能性があります.ネット上では、自分で解決できるように検索できます(google検索をお勧めします).
ここでは主にspringfox-swagger 2依存のswagger-models swagger-coreのバージョンを見て、私はここで1.5になります.9バージョンを1.5に変更しました.16

   
       io.swagger
       swagger-models
       1.5.16
   
   
       io.swagger
       swagger-core
       1.5.16
   

衝突を解決して下へ進む

    
        io.github.swagger2markup
        swagger2markup
        1.3.1
    

テストクラスを書きます

    @Test
    public void generateAsciiDocs() throws Exception {
        //      Ascii  
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        URL url = new URL("http://ip:  /   /v2/api-docs");
        Swagger2MarkupConverter.from(url)
                .withConfig(config)
                .build()
                .toFolder(Paths.get("D:\\"));
    }

テストクラスを実行すると4つ得ることができます.adocのファイル.MarkupLanguageでは、生成されたドキュメントのフォーマットを設定できます.
それからhtmlとpdfドキュメントを生成するには、ASCIIDOCを生成するために必要なmavenプラグインを追加する必要があります.

    
    
        io.github.swagger2markup
        swagger2markup-maven-plugin
        1.2.0
        
            http://ip:      /v2/api-docs
            src/docs/asciidoc/generated
            
                
                ASCIIDOC
            
        
    

PDFとHTMLのmavenプラグインを出力

    
        org.asciidoctor
        asciidoctor-maven-plugin
        1.5.3

        
            
                org.asciidoctor
                asciidoctorj-pdf
                1.5.0-alpha.10.1
            
            
                org.jruby
                jruby-complete
                1.7.21
            
        

        
            src/docs/asciidoc/generated
            coderay
            
                left
            
        

        
            
                output-html
                generate-resources
                
                    process-asciidoc
                
                
                    html5
                    src/docs/asciidoc/html
                
            

            
                output-pdf
                generate-resources
                
                    process-asciidoc
                
                
                    pdf
                    src/docs/asciidoc/pdf
                
            
        
    

構成が完了したら、まずasciidoctor-maven-pluginプラグインのコマンドを実行してadocファイルを生成し、generate-resourcesコマンドを実行して静的ドキュメントを出力する必要があります.このプラグインはadocファイルに基づいて生成されたPDFとHTMLなので、順序を間違えてはいけません.最後に出力されたPDFファイルはsrc/docs/asciidoc/pdfディレクトリの下にあります.
//adocファイルmvn asciidoctorの生成:process-asciidoc//pdfとhtml mvn generate-resourcesの生成ここで順番に実行します.私はこの最初のコマンドを実行するときに問題コンソール紙「io/console not supported;tty will not be manipulated」を発見しました.ネット上で検索しても解決策が見つからなかったので、私が検索したのは注意していないかもしれません.友达が何か原因を知っているなら教えてください.どうせ最初の命令は生存のためです.adocのファイルなので、最初のテストクラスで生成し、コマンド2を実行してhtmlとpdfをスムーズに生成しました.
Springcloudのいくつかの基礎フレームワークの構築https://github.com/foryq.