Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up

easy and powerful API documentation tool for spring restdocs

License

NotificationsYou must be signed in to change notification settings

BGMSound/documentify

Repository files navigation

Latest ReleaseApache 2.0 license
Documentify allows easy and convenient creation of OpenAPI specification documents through Kotlin DSL, making users from the complexity of traditional RestDocs.It combines the advantages of both Swagger and RestDocs for efficient and intuitive document management.

Installation and Getting Started

Installation

Add the following dependency to yourbuild.gradle.kts file:

MVC

dependencies {    implementation("io.github.bgmsound:documentify-mvc:${version}")}

WebFlux

dependencies {    implementation("io.github.bgmsound:documentify-reactive:${version}")}

Getting Started

First, make your test class extendsDocumentify. and set up the test environment like this:

@BeforeEachfunsetUp(provider:RestDocumentationContextProvider) {    testService= mockk()    standalone(provider) {        controllers(TestController(testService))    }}

You can also set up the test environment with an application context or an auto-configured MockMvc (or WebTestClient).

Mvc Example

webApplicationContext(provider, context)mockMvc(provider, mockMvc)

Reactive Example

applicationContext(provider, context)webTestClient(provider, webTestClient)

And add the following code to your test class:

@BeforeEachfunsetUp(provider:RestDocumentationContextProvider) {    standalone(provider) {        controllers(TestController(testService))    }}@TestfundocumentationGetApi() {    every { testService.test() } returnsSampleResponse("path","test")        documentation("test-get-api") {        information {            summary("test get api")            description("this is test get api")            tag("test")        }        requestLine(Method.GET,"/api/test/{path}") {            pathVariable("path","path","path")        }        responseBody {            field("testField1","path","path")            field("testField2","message","test")        }    }}

Generate OpenAPI Specification

After setting up the test environment and writing the test code, run the test.The OpenAPI specification document will be generated in thebuild/generated-snippets directory.

First, apply documentify plugin to yourbuild.gradle.kts file:

plugins {    id("io.github.bgmsound.documentify") version"${version}"}

Then, write openapi configuration in yourbuild.gradle.kts file:

openapi3 {     title="Sample API"    description="This is a sample API documentation."    version="0.0.1"    format="yaml"}

Finally, run the following command:

./gradlew openapi3./gradlew openapi

you can also create Postman collection by running the following command:

./gradlew postman

[click to see more sample code]

[8]ページ先頭
©2009-2025 Movatter.jp