com.github.open-source-sharing:restdoc-client-api

License	GNU General Public License v3.0
Categories	CLI User Interface
GroupId	com.github.open-source-sharing
ArtifactId	restdoc-client-api
Last Version	1.0.RELEASE
Release Date	Oct 26, 2020
Type	jar
Description
Source Code Management	https://github.com/Open-source-sharing/REST-doc

Download restdoc-client-api

Filename	Size
restdoc-client-api-1.0.RELEASE.pom
restdoc-client-api-1.0.RELEASE.jar	31 KB
restdoc-client-api-1.0.RELEASE-sources.jar	7 KB
restdoc-client-api-1.0.RELEASE-javadoc.jar	24 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.open-source-sharing/restdoc-client-api/ -->
<dependency>
    <groupId>com.github.open-source-sharing</groupId>
    <artifactId>restdoc-client-api</artifactId>
    <version>1.0.RELEASE</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.open-source-sharing/restdoc-client-api/
implementation 'com.github.open-source-sharing:restdoc-client-api:1.0.RELEASE'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.open-source-sharing/restdoc-client-api/
implementation ("com.github.open-source-sharing:restdoc-client-api:1.0.RELEASE")

Apache Buildr

'com.github.open-source-sharing:restdoc-client-api:jar:1.0.RELEASE'

Apache Ivy

<dependency org="com.github.open-source-sharing" name="restdoc-client-api" rev="1.0.RELEASE">
  <artifact name="restdoc-client-api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.open-source-sharing', module='restdoc-client-api', version='1.0.RELEASE')
)

Scala SBT

libraryDependencies += "com.github.open-source-sharing" % "restdoc-client-api" % "1.0.RELEASE"

Leiningen

[com.github.open-source-sharing/restdoc-client-api "1.0.RELEASE"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-web	jar
org.springframework.boot : spring-boot-configuration-processor Optional	jar
com.github.open-source-sharing : restdoc-remoting	jar	1.0.RELEASE
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.3.72

test (1)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-test	jar	1.3.72

Project Modules

There are no modules declared in this project.

Opensource Sharing RESTdoc Project

RESTdoc Project是一款提升研发效能的文档软件，集测试与文档生成于一体，快速导入应用的Http API或者RPC API来快速生成文档。

工作模式(Work mode)

RESTdoc分为两个模块，RESTdoc-console和RESTdoc-client，RESTdoc-console是文档可视化工作驾驶舱，您可以只选择RESTdoc-console模块进行文档的编写， 如果您想快速把应用的API同步到RESTdoc-console，并且可视化展示和测试，那么就需要RESTdoc-client来帮助您完成这个需求，只需要按照以下步骤，快速接入您的应用即可。

架构图(Architecture)

快速安装RESTdoc-console

• docker-compose一键安装(推荐)
• 源码安装

快速接入你的应用

• Maven dependency
  

普通web应用

<dependency>
  <groupId>com.github.open-source-sharing</groupId>
  <artifactId>restdoc-restweb-client</artifactId>
  <version>1.0.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.jetbrains.kotlin</groupId>
  <artifactId>kotlin-reflect</artifactId>
  <version>1.3.72</version>
</dependency>

dubbo应用

<dependency>
  <groupId>com.github.open-source-sharing</groupId>
  <artifactId>restdoc-dubbo-client</artifactId>
  <version>1.0.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.jetbrains.kotlin</groupId>
  <artifactId>kotlin-reflect</artifactId>
  <version>1.3.72</version>
</dependency>

• 配置application.yml/application.properties

application.yml

restdoc:
  host: 127.0.0.1  # RESTdoc-console的IP地址
  port: 4321   # 固定端口

application.properties

restdoc.host=127.0.0.1  # RESTdoc-console的IP地址
restdoc.port: 4321   # 固定端口

3 启动你的应用

RESTdoc-console线上体验

RESTdoc线上体验地址
登录账户:
账户：Maple
密码：Maple

Versions

Version
1.0.RELEASE Oct 26, 2020