API文档管理工具-数据库表结构思考.

API文档管理工具-数据库表结构思考.

PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API
Developer)之间的工作协调,同时也是由于本人不擅长word文档编写,程序及设计简单,大牛勿喷!

  • API基础信息表


    CREATE TABLE API_Infor
    2 (
    3 ApiID uniqueidentifier PRIMARY KEY
    4 ,ApiCategory int
    5 ,ApiSupport nvarchar(100)
    6 ,ApiName nvarchar(200)
    7 ,ApiMemo nvarchar(1000)
    8 ,ApiVersion nvarchar(5)
    9 ,ApiStatus int
    10 ,ApiVerbs int
    11 ,ApiSecurity int
    12 ,ApiKey nvarchar(100)
    13 ,ApiToken nvarchar(100)
    14 ,ApiRequest nvarchar(4000)
    15 ,ApiResponse nvarchar(4000)
    16 ,ApiTags nvarchar(100)
    17 ,ApiResource nvarchar(500)
    18 ,ApiInUser int
    19 ,ApiInDate datetime
    20 ,ApiEditUser int
    21 ,ApiEditDate datetime
    22 )



  • API分类信息表


1 CREATE TABLE API_Category
2 (
3 CategoryID int PRIMARY KEY
4 ,ParentID int
5 ,CategoryName nvarchar(100)
6 ,CategoryImage nvarchar(200)
7 )

  • API访问表

1 CREATE TABLE API_Called_Infor
2 (
3 CalledID int PRIMARY KEY
4 ,ApiID int
5 ,InDate datetime
6 )

  • API管理用户表


    1 CREATE TABLE API_User
    2 (
    3 UserID int PRIMARY KEY
    4 ,LoginName NVARCHAR(100)
    5 ,UserName NVARCHAR(100)
    6 ,Password NVARCHAR(100)
    7 ,Status INT
    8 )

时间: 2024-08-07 04:31:06

API文档管理工具-数据库表结构思考.的相关文章

API文档管理工具折射出的技术视野

# 什么是技术视野 网上看到不少关于如何提升技术视野的讨论,但却没有人给出定义,到底什么是技术视野? **所谓技术视野,就是看问题时所能切换的不同角(维)度.** 下面就以API管理工具(以下简称"管理工具")为例,来探讨背后隐藏的技术视野. # API管理工具 ## 零视角 曾经在一个小型创业公司用到过最简单的管理工具,就是一个开源的文档管理工具,界面功能类似wiki(维基百科). 这样的工具确实能满足核心需求--API在线文档化,并支持用户管理. 可是深想一层,对于管理工具的使用者

Velocity API文档管理查询工具使用心得

Mac上的Dash是一款非常出色的API文档管理工具,是程序开发的绝佳辅助工具.我曾经期望Dash会推出Windows版本,遗憾的是,作者Kapeli没有这个打算.而当时,他推荐了Zeal这个开源工程给我. 不久前,Kapeli更新了他的博客,分享了一款Windows上的API Documentation工具 - Velocity.虽然是由他人开发,但是Kapeli非常慷慨的提供了文档数据. Velocity的最新版本是1.0.2,在使用过程中还存在着一些问题,我在刚开始用的时候,切换了一下网络

Api接口文档管理工具,你知道哪些呢?

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

showdoc 开源在线api&&技术文档管理工具

showdoc 是一个很不错的api 以及技术文档管理工具 环境准备 doker-copose 文件 version: "3" services: doc: image: registry.docker-cn.com/star7th/showdoc volumes: - "./showdoc_data/html:/var/www/html/" ports: - "8080:80" 启动&&配置 启动 docker-compose

强烈推荐 在线接口文档管理工具 小幺鸡 小团队可以省掉测试了

在朋友那儿看到一个不错的在线文档管理工具 主要特点 : 在线接口测试 在线测试,方便前后端开发,降低错误率.支持:xml.json.txt.binary.websocket 可视化编辑与分享 可视化编辑器,完善的分享机制,多功能导出.让接口撰写变得十分简单 安全保障 基于阿里云服务器,提供安全备份系统.多家公司使用,安全证明. 代码开源 可离线安装到内网服务器仅供公司内部使用.接口在线测试,降低接口错误率 开放源码,支持任意修改 简洁明了的API 简单的维护更新 多种导出满足不同需求 自己搭建试

GIT+云盘作 做 文档管理工具

GIT+云盘作 做 文档管理工具 在工作中, 会遇到公司的文档 和 自己家里的 文档进行同步的问题, 通常我们使用U盘作为传输节制, 但是不是非常好,文档的改动都不能发现, 导致回家同步的时候, 出各种问题. 这时候我们 就可以 考虑使用GIT了,  外加一个百度云盘 则就顺利的完成了 文档同步和历史文档管理 1.  下载必要的工具msysgit+git tortoise + 百度同步盘. 2.  安装三个工具, 并且在初次使用git tortoise 的时候需要指向msysgit的bin目录

Web API文档生成工具apidoc

apidoc可以根据代码注释生成web api文档,支持大部分主流语言java javascript php coffeescript erlang perl python ruby go...,相对而言,web接口的注释维护起来更加方便,不需要额外再维护一份文档. apidoc从注释生成静态html网页文档,不仅支持项目版本号,还支持api版本号. 安装 主页: http://apidocjs.comgithub: https://github.com/apidoc/apidoc可以使用npm

api文档生成工具 C#

要为编写的程序编写文档,这是件费力气的事,如果能自动生成就好了. 不怕做不到,就怕想不到.这不,搜索到了Sandcastle 比较好的参考文章: 1.Sandcastle官方网址: http://shfb.codeplex.com/ 2.使用SandCastle创建.Net帮助文档 http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html 3.NET项目工程生成一份项目帮助文档chm--Sandcastle工具 参考这篇文

使用kettle把XML文档转换成数据表结构

 在kettle中Get data from xml 步骤和 XML Input Stream (StAX)步骤读取并解析xml文件.Get data from xml 步骤使用dom方式解析,比较消耗内存,当文件很大时,就不可取.XML Input Stream (StAX)步骤使用完全不同的方式解析大而复杂的文件,且能快速载入数据,所以建议使用该步骤. 下面通过示例来展示如何使用该步骤,源xml文件内容如下: <?xml version="1.0"?> <ti