㈠ 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加密的