JarCastingdubboDoc
Dubbo api documents, test tools, generate documents according to annotations, and provide test functions
Only some annotations are needed to generate documents similar to swagger, without turning a non web's dubbo project into a web project.
Welcome everyone to make complaints about it~
At present, the function of the first version is relatively rough (the interface is also rough), and the user experience is not very good. It will be gradually optimized later, and all kinds of PR are welcome~
When testing Dubbo providers, I always thought that if Dubbo had a document + testing
tool similar to swagger
I've also found that several of them are based on springfox, and will add some restful
interfaces to Dubbo project,if your Dubbo service itself is started through a web container
or mixed with web projects, that's fine.
But my Dubbo projects are all non web projects. For those with obsessive-compulsive disorder,
it is a little unacceptable to turn the project into a web project for the purpose of documentation,
so I have the idea of doing it myself...
Version planning
First edition
- Parsing annotations and generating UI
- Unfriendly user interface (without handling some exceptions)
Second edition
- Replace the JSON text area with a proper JSON editor, and verify the JSON format
- Add tabs
- It can save the test and facilitate the next direct loading test
- Some exceptions are handled as friendly text prompts
- Add remark.md and show it in the front end
- Add changelog.md and show it in the front end
Follow up edition
- Demand based on own use and issue planning
- Planning according to Dubbo upgrading
Registry center suppor
- In theory, all registries supported by Dubbo support
How to use?
- Dubbo doc annotation added to method parameters of Dubbo project
- Dubbo provider project introduces Dubbo doc core
- If Dubbo's interface and parameters are a separate jar package project, introduce Dubbo doc annotations
Current Version: 1.0.4
<dependency>
<groupId>top.klw8.alita.dubbodoc</groupId>
<artifactId>dubbo-doc-annotations</artifactId>
<version>${dubboDoc-version}</version>
</dependency>
<dependency>
<groupId>top.klw8.alita.dubbodoc</groupId>
<artifactId>dubbo-doc-core</artifactId>
<version>${dubboDoc-version}</version>
</dependency>
2.Download dubbo-doc-ui-server Download
-
Start dubbo-doc-ui-server
-
Visit: http:// localhost:8888
- Port can be modified in application.yml
- swagger-ui http:// localhost:8888/swagger-ui.html
Annotation use
- @DubboApiModule class annotation: dubbo API module information, used to mark the purpose of an interface class module
- value: module name
- apiInterface: Provider implemented interface
- version: module version
- @DubboApi method annotation: dubbo API information, used to mark the purpose of an dubbo API
- value: API name
- description: API description(HTML tags available)
- version: API version
- responseClassDescription: response class description
- @RequestParam class property/method Parameter annotation: mark request parameters
- value: parameter name
- required: true/false required parameter
- description: parameter description
- example: parameter example
- defaultValue: parameter default value
- allowableValues: Allowed values. After setting this property, a drop-down list will be generated for the parameter
- Note: a drop-down selection box will be generated after using this property
- Parameters of boolean type do not need to be set with this property. A drop-down list of true / false will be generated by default
- Parameters of enumeration type will automatically generate a drop-down list. If you do not want to open all enumeration values, you can set this property separately.
- @ResponseProperty Class attribute annotation: mark response parameters
- value: parameter name
- example: example
dubbo-doc-ui
- Get API list direct connection:
Because Dubbo services with different functions may be registered in the same registration center, but the name of the interface used by Dubbo doc is the same, so the interface of Dubbo doc uses direct connection to obtain the list of different interfaces of different functions.
- The test can be connected directly or through the registration center
swagger-ui TODO
Use note
- The response bean (the return type of the interface) supports custom generics, but only one generic placeholder.
- About the use of Map: the key of map can only use the basic data type. If the key of map is not the basic data type, the generated key is not in the standard JSON format, and an exception will occur
- The API's synchronous / asynchronous is from org.apache.dubbo.config.annotation.Service.async
Project structure
- dubbo-doc-annotations: Document generation annotation project
- dubbo-doc-core: Responsible for annotation analysis and document information acquisition interface (Dubbo API)
- dubbo-doc-ui-server: Web service, responsible for displaying doc and providing testing function
- dubbo-doc-console: The front-end project will be packaged into Dubbo doc UI server project when it is published
- dubbo-doc-examples: Use example
- readmeImgs: Pictures used by README.md
Major dependent version
- spring-boot: 2.3.4.RELEASE
- dubbo: apache dubbo 2.7.8
- icework in front(iceworks 4.0)
What did Dubbo Doc do ?
Annotations
- Define annotations to describe interfaces and parameters
In Dubbo projects that need to generate documentation and tests
- Parsing annotations and caching
- Add Dubbo API used by Dubbo doc to obtain interface information
dubbo-doc-ui-server
- Web service
- Restful API used by front-end UI to obtain interface information (interface list, information of specified interface)
- Request the restful API of the Dubbo service (using the method of Dubbo generalization call)
- Save the test and display it next time (implemented in the Second Edition)
dubbo-doc-console(Package to dubbo-doc-ui-server when publishing)
- Get the interface list and display it according to the specified Dubbo service IP and port (direct connection Dubbo service)
- Get the interface information according to the specified interface and generate the form with DOC (similar to swagger)
- Show API request response