最全在线接口文档预言方案，2024年最新C C++编程基础培训

最新推荐文章于 2024-08-23 18:37:03 发布

2401_84976040

最新推荐文章于 2024-08-23 18:37:03 发布

阅读量262

点赞数 3

文章标签： c语言 c++ 学习

本文链接：https://blog.csdn.net/2401_84976040/article/details/138950484

版权

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上C C++开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取


CMakeLists.txt

cmake_minimum_required (VERSION 3.10)

message(STATUS “Build documentation open”)
#SrcFile 表示需要解析的目录
set(SrcFile ${CMAKE_CURRENT_LIST_DIR}/…/src)

include(build_doxygen.cmake)
build_doxygen()


build\_doxygen.cmake

macro(build_doxygen)

FIND_PACKAGE(Doxygen)
IF(${DOXYGEN_FOUND})
SET(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
SET(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

CONFIGURE_FILE(${doxyfile_in} ${doxyfile} @ONLY)

ADD_CUSTOM_TARGET(doc
    COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
    COMMENT "Generating API documentation with Doxygen"
    VERBATIM)

install(CODE "execute_process(
  COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
  COMMAND_ECHO STDOUT
  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/build/
)")

INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_PREFIX}/doc)

else()
MESSAGE(WARNING “Doxygen is needed to build the documentation.Run sudo apt-get install doxygen doxygen-doc doxygen-gui graphviz”)
ENDIF()

endmacro()


查阅：


[cmake使用doxygen生成document\_doxygen cmake\_六月的雨唯你的博客-CSDN博客](https://bbs.csdn.net/topics/618668825)


[Doxygen 注释语法规范 - schips - 博客园 (cnblogs.com)](https://bbs.csdn.net/topics/618668825)‘


### 三、落地apidoc


apidoc 官网：[apidoc/apidoc: RESTful web API Documentation Generator. (github.com)](https://bbs.csdn.net/topics/618668825)


1、安装nodejs，因为后面apidoc也是通过nodejs安装最好版本对应，不然会出现错  
 安装14.2版本


https://blog.csdn.net/qq\_36553707/article/details/122849920


2、npm下载apidoc


sudo npm install apidoc -g


3、直接修改执行程序 apidoc (find搜索一下即可)中defaultIncludeFilters 属性，添加hpp，并在解析的时候加上-f “.hpp”


4、安装nginx，将apidoc生成的html发布到web上


nginx安装 https://blog.csdn.net/qq\_36553707/article/details/122849920  
 nginx配置服务 https://blog.csdn.net/qqq2018/article/details/106245836

打开/etc/nginx/nginx.conf，在http的大括号最后加入server配置
server {
listen 8080;
server_name example.com; # 替换为你的域名

location / {
    root /home/speedbot/workcode/apidoc-demo/apidoc;  # 替换为你 HTML 文件所在的目录
    index index.html;
}

}


5、测试dapr服务的 http 接口如何访问


https://www.cnblogs.com/magicbowie/p/15596792.html  
 https://v1-5.docs.dapr.io/zh-hans/reference/api/service\_invocation\_api/


6、进行在线测试(目前因为dapr跨越问题无法测试，websocket 不支持)


7、支持post和get两种方式，


apidoc升级


进入容器/opt/source/apidoc 替换需要修改的文件即可。


### 四、落地oat++swaggercpp


直接参考：[C++ RESTful web service with Swagger-UI and auto-documented endpoints | oatpp (medium.com)](https://bbs.csdn.net/topics/618668825)


主要需下载1.1.0版本的oat++和oatswagger，否则会出现一些错误或者编译条件的约束。


接入比较复杂。


### 五、总结


![img](https://img-blog.csdnimg.cn/img_convert/ab31f42bcbed40cc762133880a65359c.png)
![img](https://img-blog.csdnimg.cn/img_convert/a65b321e5dd111bac2cd73f3b49d7675.png)

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上C C++开发知识点，真正体系化！**

**由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新**

**[如果你需要这些资料，可以戳这里获取](https://bbs.csdn.net/topics/618668825)**

C C++开发知识点，真正体系化！**

**由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新**

**[如果你需要这些资料，可以戳这里获取](https://bbs.csdn.net/topics/618668825)**