সোয়াগার এপিআই ডকুমেন্টেশন থেকে পিডিএফ তৈরি করুন

Question 1

আমি আমার আরআরএসটি ওয়েব পরিষেবাগুলি প্রদর্শন করতে সোয়াগার ইউআই ব্যবহার করেছি এবং এটি একটি সার্ভারে হোস্ট করেছি।

তবে সোয়াগারের এই পরিষেবাটি কেবলমাত্র একটি নির্দিষ্ট সার্ভারে অ্যাক্সেস করা যায়। আমি যদি অফলাইনে কাজ করতে চাই, তবে কেউ কীভাবে জানতে পারে যে আমি সোয়াগার ইউআই ব্যবহার করে একটি স্ট্যাটিক পিডিএফ তৈরি করব এবং এর সাথে কাজ করব? অতিরিক্ত হিসাবে একটি সার্ভারে অ্যাক্সেস নেই এমন লোকদের সাথে একটি পিডিএফ ভাগ করা সহজ।

অনেক ধন্যবাদ!

Question 2

সহজ উপায়: ব্রাউজার মুদ্রণ / পূর্বরূপ ব্যবহার করে

সম্পাদক ফলকটি লুকান
মুদ্রণ পূর্বরূপ (আমি ফায়ারফক্স ব্যবহার করেছি, অন্যরাও ভাল)
এর পৃষ্ঠা সেটআপ পরিবর্তন করুন এবং পিডিএফ প্রিন্ট করুন

Question 3

আমি https://github.com/springfox/springfox এবং https://github.com/RobWin/swagger2markup ব্যবহার করে একটি উপায় খুঁজে বের করেছি

ডকুমেন্টেশন প্রয়োগের জন্য সোয়াগার 2 ব্যবহার করা হয়েছে।

Question 4

আপনি আপনার আরএসটি প্রকল্পটি পরিবর্তন করতে পারেন, যাতে প্রকল্পটি নির্মাণের পরে প্রয়োজনীয় স্ট্যাটিক ডকুমেন্ট (এইচটিএমএল, পিডিএফ ইত্যাদি) উত্পাদন করতে পারেন।

আপনার যদি জাভা মাভেন প্রকল্প থাকে তবে আপনি নীচের পম স্নিপেট ব্যবহার করতে পারেন। এটি একটি পিডিএফ এবং এইচটিএমএল ডকুমেন্টেশন (প্রকল্পের আরএসটি সংস্থানসমূহের) উত্পন্ন করতে প্লাগইনগুলির একটি সিরিজ ব্যবহার করে।

রেস্ট-এপিআই -> swagger.json: swagger-maven- প্লাগইন
swagger.json -> Asciidoc: swagger2markup-maven-પ્લગઇન
এসকিডোক -> পিডিএফ: এসিইডোক্টর-ম্যাভেন-প্লাগইন

একটি প্লাগইন আউটপুট যেহেতু মৃত্যুদন্ড কার্যকর করার আদেশটি পরবর্তী ক্ষেত্রে ইনপুট হয়ে উঠেছে তা দয়া করে সচেতন হন:

<plugin>
    <groupId>com.github.kongchen</groupId>
    <artifactId>swagger-maven-plugin</artifactId>
    <version>3.1.3</version>
    <configuration>
        <apiSources>
            <apiSource>
                <springmvc>false</springmvc>
                <locations>some.package</locations>
                <basePath>/api</basePath>
                <info>
                    <title>Put your REST service's name here</title>
                    <description>Add some description</description>
                    <version>v1</version>
                </info>
                <swaggerDirectory>${project.build.directory}/api</swaggerDirectory>
                <attachSwaggerArtifact>true</attachSwaggerArtifact>
            </apiSource>
        </apiSources>
    </configuration>
    <executions>
        <execution>
            <phase>${phase.generate-documentation}</phase>
            <!-- fx process-classes phase -->
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>io.github.robwin</groupId>
    <artifactId>swagger2markup-maven-plugin</artifactId>
    <version>0.9.3</version>
    <configuration>
        <inputDirectory>${project.build.directory}/api</inputDirectory>
        <outputDirectory>${generated.asciidoc.directory}</outputDirectory>
        <!-- specify location to place asciidoc files -->
        <markupLanguage>asciidoc</markupLanguage>
    </configuration>
    <executions>
        <execution>
            <phase>${phase.generate-documentation}</phase>
            <goals>
                <goal>process-swagger</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.3</version>
    <dependencies>
        <dependency>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctorj-pdf</artifactId>
            <version>1.5.0-alpha.11</version>
        </dependency>
        <dependency>
            <groupId>org.jruby</groupId>
            <artifactId>jruby-complete</artifactId>
            <version>1.7.21</version>
        </dependency>
    </dependencies>
    <configuration>
        <sourceDirectory>${asciidoctor.input.directory}</sourceDirectory>
        <!-- You will need to create an .adoc file. This is the input to this plugin -->
        <sourceDocumentName>swagger.adoc</sourceDocumentName>
        <attributes>
            <doctype>book</doctype>
            <toc>left</toc>
            <toclevels>2</toclevels>
            <generated>${generated.asciidoc.directory}</generated>
            <!-- this path is referenced in swagger.adoc file. The given file will simply 
                point to the previously create adoc files/assemble them. -->
        </attributes>
    </configuration>
    <executions>
        <execution>
            <id>asciidoc-to-html</id>
            <phase>${phase.generate-documentation}</phase>
            <goals>
                <goal>process-asciidoc</goal>
            </goals>
            <configuration>
                <backend>html5</backend>
                <outputDirectory>${generated.html.directory}</outputDirectory>
                <!-- specify location to place html file -->
            </configuration>
        </execution>
        <execution>
            <id>asciidoc-to-pdf</id>
            <phase>${phase.generate-documentation}</phase>
            <goals>
                <goal>process-asciidoc</goal>
            </goals>
            <configuration>
                <backend>pdf</backend>
                <outputDirectory>${generated.pdf.directory}</outputDirectory>
                <!-- specify location to place pdf file -->
            </configuration>
        </execution>
    </executions>
</plugin>

এসিইডোক্টর প্লাগইন কাজ করার জন্য একটি .adoc ফাইলের অস্তিত্ব ধরে নেয়। আপনি এমন একটি তৈরি করতে পারেন যা সোয়াগার 2মার্কআপ প্লাগইন দ্বারা তৈরি করা সহজভাবে সংগ্রহ করে:

include::{generated}/overview.adoc[]
include::{generated}/paths.adoc[]
include::{generated}/definitions.adoc[]

যদি আপনি চান যে আপনার উত্পন্ন এইচটিএমএল ডকুমেন্টটি আপনার যুদ্ধের ফাইলের অংশ হয়ে উঠতে পারে তবে আপনাকে নিশ্চিত করতে হবে যে এটি শীর্ষ স্তরে উপস্থিত রয়েছে - ডাব্লুইউ-আইএনএফ ফোল্ডারে স্থির ফাইলগুলি পরিবেশন করা হবে না। আপনি maven- যুদ্ধ-প্লাগইন এ এটি করতে পারেন:

<plugin>
    <artifactId>maven-war-plugin</artifactId>
    <configuration>
        <warSourceDirectory>WebContent</warSourceDirectory>
        <failOnMissingWebXml>false</failOnMissingWebXml>
        <webResources>
            <resource>
                <directory>${generated.html.directory}</directory>
            <!-- Add swagger.pdf to WAR file, so as to make it available as static content. -->
            </resource>
            <resource>
                <directory>${generated.pdf.directory}</directory>
            <!-- Add swagger.html to WAR file, so as to make it available as static content. -->
            </resource>
        </webResources>
    </configuration>
</plugin>

যুদ্ধের প্লাগইন উত্পন্ন ডকুমেন্টেশনের উপর কাজ করে - যেমন আপনাকে অবশ্যই নিশ্চিত করতে হবে যে সেই প্লাগইনগুলি পূর্বের পর্যায়ে কার্যকর করা হয়েছে।

Question 5

আমি একটি ওয়েবসাইট https://www.swdoc.org/ তৈরি করেছি যা বিশেষত সমস্যাটির সমাধান করে। সুতরাং এটি swagger.json -> Asciidoc, Asciidoc -> pdfউত্তর হিসাবে প্রস্তাবিত রূপান্তর স্বয়ংক্রিয়ভাবে । এর সুবিধা হ'ল আপনাকে ইনস্টলেশন প্রক্রিয়াটি অতিক্রম করতে হবে না। এটি ইউআরএল বা কেবল একটি কাঁচা জসন আকারে একটি নির্দিষ্ট নথি গ্রহণ করে। প্রকল্পটি সি # তে লিখিত এবং এর পৃষ্ঠাটি https://github.com/Irdis/SwDoc

সম্পাদনা

: এটা এখানে আপনার JSON চশমা যাচাই করতে একটি ভাল ধারণা হতে পারে http://editor.swagger.io/ যদি আপনি SwDoc সঙ্গে কোনো সমস্যা হচ্ছে কিনা মত পিডিএফ অসম্পূর্ণ তৈরি করা হচ্ছে।

Question 6

চেকআউট https://mrin9.github.io/RapiPdf প্রচুর কাস্টমাইজেশন এবং স্থানীয়করণ বৈশিষ্ট্য সহ একটি কাস্টম উপাদান।

দাবি অস্বীকার: আমি এই প্যাকেজের লেখক

Question 7

আমার কাছে সবচেয়ে সহজ সমাধানটি ছিল পোস্টম্যানের মধ্যে সোয়াগার (v2) আমদানি করা এবং তারপরে ওয়েব ভিউতে যাওয়া। সেখানে আপনি "একক কলাম" দেখতে এবং পিডিএফ প্রিন্ট করতে ব্রাউজারটি ব্যবহার করতে পারেন। কোনও স্বয়ংক্রিয় / সংহত সমাধান নয় তবে একক-ব্যবহারের জন্য ভাল। এটি edit2.swagger.io থেকে মুদ্রণের চেয়ে কাগজের প্রস্থকে অনেক ভাল পরিচালনা করে, যেখানে স্ক্রোলবারগুলি সামগ্রীর অংশগুলিকে গোপন করে।