㈠ java webapi接口怎么写
package com.dataMonitor.bo.common;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.sf.json.JSONObject;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import org.apache.http.HttpEntity;
㈡ 如何使 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 文档展示效果
㈢ webapi接口的调用方式怎么写
被人的API在哪呢？如果是代码就把代码加到你的工程就可以调用了。如果是dll的话要把别人的dll和相关头文件加到你的工程。
㈣ web前端怎么调用api接口
1、首先需要确定第三方的接口的基本信息：地址、请求方式，参数、返回值，接口模式这里第三方的接口是restful风格的，采用get请求。
㈤ 怎样保证对外作为公共接口的webapi的安全性
现在很多网站都要用到api接口了吧~而且有些程序和网站通讯也必须用到接口。不过接口的最主要安全问题就是逻辑判断的问题比如最常见的就是支付接口，支付接口。举个例子，比如这是某支付的接口的判断处理这只是个简化版的~只提取了部分的漏洞，好吧orderID打成了orederid了。凑合着吧~然后写个html模拟post提交不过现在部分支付接口都修复了这个漏洞，改成了主动到服务器上查询支付状态~而不是被动等待服务器返回~但是仍然有一些支付公司没有修复这个漏洞，比如国外某机房的面板，而且这个面板还是很多人都用的收费面板~他的信用卡支付的地方就没有进行验证，如果有账单，选信用卡，用firebug之类的改一个别人的信用卡ID，就可以用别人的信用卡支付（强烈不推荐！！并bs此行为）还有一种漏洞就是程序与web进行通讯，上次在eyuyan.com上看到的~我一看他写的与web进行通讯验证的时候的接口，没有对sql注入做任何过滤~
㈥ c#webapi怎么调用接口并传参数
使用WebApi也有段时间了，今天就记录下API接口传参的一些方式方法，算是一个笔记，也希望能帮初学者少走弯路
㈦ 如何访问WebAPI接口被恶意调用
先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。 其中的TestModle是一个简单的class，如下 public class TestModle { public string a { get; set; } public string b { get; set; } public string c { get; set; } } 前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值 前端代码中加载jquery，在定义四个按钮的click事件 get和post，我习惯用$.get和$.post，当然也能用$.ajax. get直接返回webapi get的return值，post的话我就不在后端做处理了直接返回传入的值，这里只做示范 put和delete，只能用$.ajax来处理。 put的话一般用于update某个id的数据信息 delete用于删除某个id的数据，如下图所示 点击每个按钮，可以在页面上看到相应的效果
㈧ 怎样操作WebAPI接口
先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。
其中的TestModle是一个简单的class，如下
public class TestModle
{
public string a { get; set; }
public string b { get; set; }
public string c { get; set; }
}
前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值
前端代码中加载jquery，在定义四个按钮的click事件
get和post，我习惯用$.get和$.post，当然也能用$.ajax.
get直接返回webapi get的return值，post的话我就不在后端做处理了直接返回传入的值，这里只做示范
put和delete，只能用$.ajax来处理。
put的话一般用于update某个id的数据信息
delete用于删除某个id的数据，如下图所示
点击每个按钮，可以在页面上看到相应的效果
本回答由提问者推荐
评论
1 1
xzozxzb | 汽车顾问向TA咨询
擅长： 汽车
其他回答
先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。
其中的TestModle是一个简单的class，如下
public class TestModle
{
public string a { get; set; }
public string b { get; set; }
public string c { get; set; }
}
前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值
前端代码中加载jquery，在定义四个按钮的click事件
get和post，我习惯用$.get和$.post，当然也能用$.ajax.
get直接返回webapi get的return值，post的话我就不在后端做处理了直接返回传入的值，这里只做示范
put和delete，只能用$.ajax来处理。
put的话一般用于update某个id的数据信息
delete用于删除某个id的数据，如下图所示
点击每个按钮，可以在页面上看到相应的效果
㈨ .Net有没有自动生成WebAPI接口的网站或工具
建议：别绕弯路，自己写一套根据当前业务相对比较健全的api接口表示层，然后复制粘贴修改
绝大部分api需求很多时候都是根据业务复杂驱动的，即便是api的表示层也得有：业务层反射问题，api author问题，返回数据约束问题，等等。此类工具少，即使有也很难满足业务需求。
㈩ 2018年10月微信小程序上传文件的问题webapi方式
必须在微信公众平台填写请求，下载，上传，websocket 域名，必须是SSL加密的