smart-doc-template

smart doc template project

License	The Apache Software License, Version 2.0
Categories	Net
GroupId	net.xiaolanglang
ArtifactId	smart-doc-template
Last Version	1.0
Release Date	May 15, 2021
Type	jar
Description	smart-doc-template smart doc template project
Project URL	https://github.com/xiaolanglanglang/smart-doc-template
Source Code Management	https://github.com/xiaolanglanglang/smart-doc-template

Download smart-doc-template

Filename	Size
smart-doc-template-1.0.pom
smart-doc-template-1.0.jar	3 KB
smart-doc-template-1.0-sources.jar	2 KB
smart-doc-template-1.0-javadoc.jar	24 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/net.xiaolanglang/smart-doc-template/ -->
<dependency>
    <groupId>net.xiaolanglang</groupId>
    <artifactId>smart-doc-template</artifactId>
    <version>1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/net.xiaolanglang/smart-doc-template/
implementation 'net.xiaolanglang:smart-doc-template:1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/net.xiaolanglang/smart-doc-template/
implementation ("net.xiaolanglang:smart-doc-template:1.0")

Apache Buildr

'net.xiaolanglang:smart-doc-template:jar:1.0'

Apache Ivy

<dependency org="net.xiaolanglang" name="smart-doc-template" rev="1.0">
  <artifact name="smart-doc-template" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='net.xiaolanglang', module='smart-doc-template', version='1.0')
)

Scala SBT

libraryDependencies += "net.xiaolanglang" % "smart-doc-template" % "1.0"

Leiningen

[net.xiaolanglang/smart-doc-template "1.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

smart doc template

The smart doc template project aim to provide the template for those interfaces that cannot be rendered by the smart-doc project. This requires the smart-doc-maven-plugin.

Usage

1. Add the dependency to smart-doc-maven-plugin.

<plugin>
    <groupId>com.github.shalousun</groupId>
    <artifactId>smart-doc-maven-plugin</artifactId>
    <!--...-->
    <dependencies>
        <dependency>
            <groupId>net.xiaolanglang.doc</groupId>
            <artifactId>smart-doc-template</artifactId>
            <version>1.0</version>
        </dependency>
    </dependencies>
    <!--...-->
</plugin>

2. Modify the smart-doc.json file to add the apiObjectReplacements field.

{
  "apiObjectReplacements": [
    {
      "className": "org.springframework.data.domain.Pageable",
      "replacementClassName": "net.xiaolanglang.doc.spring.PageableTemplate"
    }
  ]
}

3. Use customRequestFields to modify the description, default values, etc.

{
  "customRequestFields": [
    {
      "name": "sort",
      "ownerClassName": "net.xiaolanglang.doc.spring.PageableTemplate",
      "desc": "sort field",
      "value": "createTime,desc"
    }
  ]
}

Current templates

template class	origin class
net.xiaolanglang.doc.spring.PageableTemplate	org.springframework.data.domain.Pageable

Versions

Version
1.0 May 15, 2021