手把手带你入门之Swagger UI

最新推荐文章于 2024-08-19 00:15:00 发布

数据中国

最新推荐文章于 2024-08-19 00:15:00 发布

阅读量1.9w

点赞数 1

分类专栏： UI 文章标签： Swagger UI angular-swagger-ui

本文链接：https://blog.csdn.net/chndata/article/details/50456287

版权

本文详细介绍了如何在NodeJS项目中使用和定制angular-swagger-ui，包括安装步骤、依赖项、添加到网页的方法以及基本定制过程。通过示例展示了如何创建HTML元素、引入所需库，并提供了一个定制后的API Explorer的示例，强调了API访问的安全性和控制操作的重要性。

摘要由CSDN通过智能技术生成

关于Swagger UI，从官网找来一段介绍。简单的来讲， Swagger UI就是API文档生成和测试利器。

Swagger UI is a dependency-freecollection of HTML, Javascript, and CSS assets that dynamically generatebeautiful documentation and sandbox from a Swagger-compliant API. BecauseSwagger UI has no dependencies, you can host it in any server environment, oron your local machine. Head over to the online demo to see what it looks likefor any publically accessible Swagger definition.

本文以angular-swagger-ui，一个Swagger UI的变体讲解swagger ui在NodeJS项目中的基本的应用和常见的定制

安装使用:

1. 安装 angular-swagger-ui

bower install angular-swagger-ui --save

2. Dependencies

angularJS

bootstrapCSS

3. 把Swagger UI加到你的webpage中

<scripttype="text/javascript">
    // If directive has parametertrusted-sources="true"
    angular.module('yourApp',['swaggerUi']);
    ...
    // OR if you choosed to use"ngSanitize"
    angular.