① 如何把把webService整理成接口描述文档
写明接口调用地址
写明接口入参的类型，数量，要求
写明接口出参的类型，数据模型
写明接口调用要求，比如必须要先干啥，后干啥
写明接口调用实例，比如如何调，返回值是何样的。
② WEB项目是什么
是指后台采用Java语言SSH架构，前端采用Jquery脚本以及CssBluetrip框架，数据库使用PostgreSQL。
采用JavaSSH架构开发的系统，具有卓越的易用性、兼容性及安全性上，广泛应用于个人PC、数据中心、游戏控制台、科学超级计算机、移动电话和互联网，同时拥有全球最大的开发者专业社群。
在全球云计算和移动互联网的产业环境下，Java更具备了显着优势和广阔前景。
(2)接口文档web项目扩展阅读
Web设计技术主要包括：HTML语言、Java Applets和脚本程序。
1）HTML语言。HTML是Hypertext Markup Language（超文本标记语言）的缩写，它是构成Web页面的主要工具。
2)Java Applets，即Java小应用程序。使用Java语言创建小应用程序，浏览器可以将Java Applets从服务器下载到浏览器，在浏览器所在的机器上运行。Java Applets可提供动画、音频和音乐等多媒体服务。
3)脚本程序。他是嵌入在HTML文档中的程序。使用脚本程序可以创建动态页面，大大提高交互性。用于编写脚本程序的语言主要有JavaScript和VBScript。JavaScript由Netscape公司开发，具有易于使用、变量类型灵活和无须编译等特点。
VBScript由Microsoft公司开发，与JavaScript一样，可用于设计交互的Web页面。
③ java web项目写个webservice接口,求教啊，有没有详细点的教程
axis 其实发布一个webservice很容易的!主要是你发布一个wsdl文件，启动服务后在浏览器地址栏中输入webservice地址，如果出来一些接口信息说明发布成功了。。也就是说你的接口能对外开放了。。。
④ web项目给这样的接口，我不清楚怎样做，如果是前端提交，那获取的数据到哪里了，如果用java代码怎么提交
有2个建议，1.把逻辑思路理顺了再提问题，2.多把request 与 response 之间的基础知识打好，毕竟，现在 前端HTML(vue等等框架) + 后端 API 联合开发，这个都弄不清楚怎么搞？
现在来解决可能遇到的问题
前端框架接收 不需要创建接收对象，js属于弱类型，var 直接可以接收对象
后端接收，从调用开始，创建 HttpRequest对象， 对象里设置param参数,设置Content-Type 传输类型，Send后创建HttpResponse 接收，接收对象为stream流，根据此流转成数据对象类，返回接口中对象类有headers，statusCode，statusCodeValue，body,比如headers，body为不固定参数，可以设置成（T）类型
⑤ web前端开发项目过程
老板或甲方是一个需求的真正发起者，也是一个基础idea的梦想师，产品是需求专业化梳理或进行有效评估细化需求负责的，
而设计是前端的上游，前端是设计的下游。设计的工作目的是把产品宏观的思维结果进行专业的处理，因为按一般的习惯，产品最终的结果是原型图，而原型图可以理解为设计的草图，
对真正的用户来说，这个草图过于简单或不符合使用的操作习惯，所以需要设计师进行专业的处理，比如颜色搭配，布局分隔，有时候还兼交互的一部分工作，设置用户与页面发生交互的预订流程，
那有人问，不需要设计不行吗？直接让前端写页面不就得了，还需要麻烦设计师来做个图出来。
因为这里边有一个成本风险控制的一个理念，因为在前期，尤其是设计，主观感受大于理性的思考，所以每天的结果都不一样，所以需要设计师去消化掉这部分主观感受带来的误区，
而且从成本上来讲，有些场景设计师改图比改代码要容易控制一些。
设计师的结果是psd文件，他是很多个图层叠加在一起的结果，而前端的工作结果html页面，是把很多图层上的效果，有机的用html组织起来的过程。
前端是把转化后html交给下游服务端开发工程师，或叫后台开发，这个html里边包括一些交互的js文件等。总的来说前端是一个承前启后的岗位。
也有的公司把前端的责任放大，负责整个前台view层页面的开发，这样的好与坏在前面的文章中已经探讨过就不一一细表了。
我们以前基本的流程是，领导或甲方提出需求，然后产品分析需求，并且根据需求画出原型图，然后根据原型图出设计稿。
出完设计稿团队评审，过后交与前端制作静态页面，然后静态页面，交与设计审核，过后交给开发人员，进行动态数据的添加。
添加完之后，发布测试环境，产品测试领导审核，成功后，直接发布产品环境。或进行版本迭代。
这是整个的一个设计，开发，部署的流程。
根据前面的，在补充一下，前面的所有流程中的灵魂是原始需求提出者，但人随着客观条件的变化，思维认识会有所不一致，
所以产生了文档，文档是贯穿整个流程的一个灵魂。
而产品是整个流程中文档的编写者，因为产品最能接触最原始的需求，对需求的理解更深刻或专业，所以他会有一个文档出来。
这个文档是需要交付给设计，让设计在设计过程中进行参考。
前端看的另外一个文档。交互设计师出交互文档，一般的公司没有交互设计师那就是由产品来出的交互文档。
有的交互不过于复杂，就没有文档，只是邮件。
有时候说，不要这个邮件行不行，那怕是最简单的原始东西，没有文件或邮件是不能做一个后期测试回溯的依据。
产品文档表示页面的流转或数据的走向，交互文档描述页面复杂的交互或各个用户表单与用户发生的各种互动。
另外2个是，要架构师或项目经理出的需求文档，需求文档是对整个项目的历史背景，系统开发软硬件要求，或版本信息，等等。
另外一个是由服务端工程师提供的接口文档，这里边包括一些请求类型，传参的数目与键名，还有服务端返回的参数名约定等等的，这些文档是开发中的灵魂，也是以后测试回溯的标准或依据。
⑥ 一个完整的web项目开发流程
1 需求确定
通过各种方法确定系统的功能与性能。
功能：注册、登录、查询、搜索。。。
性能：可同时支持N个并发访问，并且响应时间不低于M毫秒。。。
方法：
会议
询问
头脑风暴
原型-界面原型、业务原型。。。
本阶段是项目开发的最重要的阶段。
在WEB项目中，通常界面设计会在本阶段进行。
2 分析与设计
1 架构分析与设计
逻辑结构：
3层架构、多层架构。。。
MVC。。。
Model1或Model2
。。。
物理架构：
web服务器的分布
数据库服务器的分布
。。。
技术解决方法的确定：
Java/.net
Open Source/商业
。。。
2 业务逻辑分析
根据需求分析业务逻辑：
有哪些人使用本系统
他们会使用本系统做什么
通常他们使用本系统的步骤是怎么样的
会有哪些明显的类来支撑本系统的运行
会有哪些不同的提示会反馈给用户
。。。
本阶段与需求的确定密切相关，通常在确定需求的时候就会进行相关的分析。
3 业务逻辑设计
根据需求的分析来确定具体的类
确定类的属性
确定类的接口（方法）
确定类之间的关系
确定用户操作流程在设计上的反映
进行数据库的设计
注意：不同的项目步骤可能不尽相同
4 界面设计
设计系统的界面风格：
颜色、style
设计系统的具体“模拟”界面：
能够从头到尾
方便进行需求的确定
方便JSP程序员进行开发
。。。
3 开发环境搭建
开发工具的确定：
eclipse、Myeclipse。。。
配置管理工具的确定
测试工具的确定
文件服务器/配置服务器等的确定
。。。
4 开发-测试-开发-测试
按照设计进行开发
迅速开发原型
进行迭代开发
提早进行测试：
单元测试
黑盒测试
白盒测试
性能测试
易用性测试
。。。
5 编写文档
⑦ 求教！关于web项目接口设计的思路的一些疑问 [Java Web 开发]
用缓存不就行了？ehcache或者redis
⑧ 一个WEB项目有多少接口
一个WEB项目四个多少接口。
1、打印服务器的Web接口，打印服务器是Windows Server 2003服务器中的一种。
2、终端服务器的Web接口终端服务器是一种可以让有权限的远程网络用户。
3、流媒体服务器的Web接口。
4、远程维护Web接口远程维护功能是一项非常重要的功能。
⑨ 如何使 WebAPI 自动生成漂亮又实用在线API文档
1.1 SwaggerUI
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
1.2 Swashbuckle
Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。
2.快速开始
创建项目 OnlineAPI来封装网络音乐服务(示例下载) ，通过API可以搜索、获取音乐的信息和播放连接。
我尽量删除一些我们demo中不会用到的一些文件，使其看上去比较简洁。
WebAPI 安装 Swashbuckle
Install-Package Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的，生成 SwaggerUI，JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件，用于配置 SwaggerUI 相关展示行为的。如图：
将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
并在当前类中添加一个方法
/// <summary>
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}
紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程中生成类库的注释文件
添加网络音乐 3个API
访问 http://<youhost>/swagger/ui/index,最终显示效果
我们通过API 测试API 是否成功运行
3.添加自定义HTTP Header
在开发移动端 API时常常需要验证权限，验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可
首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter>();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =>
filterInfo.Instance).Any(filter => filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();
if (isAuthorized && !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter>();
添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary>
/// 权限验证
/// </summary>
/// <param name="actionContext"></param>
/// <returns></returns>
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}
/// <summary>
/// 处理未授权的请求
/// </summary>
/// <param name="actionContext"></param>
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}
在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]
最终显示效果
4.显示上传文件参数
SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似，只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class UploadFilter : IOperationFilter
{
/// <summary>
/// 文件上传
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) && operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter>();
API 文档展示效果
⑩ 什么是接口文档,如何写接口,有什么规范
含义是：在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。
目的是：项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发。项目维护中或者项目人员更迭，方便后期人员查看、维护。
规范是：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。
API（Application Programming Interface，应用程序接口）是一些预先定义的接口（如函数、HTTP接口），或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。
应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过 API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。
API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。