Wikis - Create

Service:

Wiki

API Version:

5.0

建立 Wiki 資源。

POST https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis?api-version=5.0

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '5.0' 以使用此版本的 API。

要求本文

名稱	類型	Description
mappedPath	string	存放庫內顯示為 Wiki 的資料夾路徑。 ProjectWiki 類型不需要。
name	string	Wiki 名稱。
projectId	string	要在其中建立 Wiki 的專案識別碼。
repositoryId	string	備份 Wiki 的 Git 存放庫識別碼。 ProjectWiki 類型不需要。
type	WikiType	Wiki 的類型。
version	GitVersionDescriptor	Wiki 的版本。 ProjectWiki 類型不需要。

回應

名稱	類型	Description
201 Created	WikiV2	Wiki 已建立

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名稱	Description
vso.wiki_write	授與讀取、建立及更新 Wiki、Wiki 頁面和 Wiki 附件的能力。

範例

Create code wiki

Create project wiki

Create code wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "version": {
    "version": "master"
  },
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Sample Response

Status code:

201

{
  "id": "9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "versions": [
    {
      "version": "master"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/9bfc671f-8116-4b3f-9aad-c17a9d677ab6",
  "type": "codeWiki",
  "name": "sampleCodeWiki",
  "projectId": "15cbba90-8ac5-450e-934c-16f43021546b",
  "repositoryId": "cd327f27-561b-45aa-9913-4af25ad85889",
  "mappedPath": "/docs"
}

Create project wiki

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wiki/wikis?api-version=5.0

{
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe"
}

Sample Response

Status code:

201

{
  "id": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "versions": [
    {
      "version": "wikiMaster"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_apis/wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "remoteUrl": "https://dev.azure.com/fabrikam/f38a86b5-98b0-49ef-ae9f-213c2b531cbe/_wiki/wikis/a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "type": "projectWiki",
  "name": "sampleProjectWiki",
  "projectId": "f38a86b5-98b0-49ef-ae9f-213c2b531cbe",
  "repositoryId": "a4cfa859-1089-4445-9ef1-837b0fbd44bd",
  "mappedPath": "/"
}

定義

名稱	Description
GitVersionDescriptor
GitVersionOptions	版本選項 - 指定版本 (的其他修飾詞，例如上一個)
GitVersionType	版本類型 (分支、標記或認可) 。 決定如何解譯識別碼
WikiCreateParametersV2	Wiki 建立參數。
WikiType	Wiki 的類型。
WikiV2	定義 Wiki 資源。

GitVersionDescriptor

名稱	類型	Description
version	string	版本字串識別碼 (標記/分支的名稱、認可) 的 SHA1
versionOptions	GitVersionOptions	版本選項 - 指定版本 (的其他修飾詞，例如上一個)
versionType	GitVersionType	版本類型 (分支、標記或認可) 。 決定如何解譯識別碼

GitVersionOptions

版本選項 - 指定版本 (的其他修飾詞，例如上一個)

名稱	類型	Description
firstParent	string	認可的第一個父代 (HEAD^)
none	string	未指定
previousChange	string	認可在目前版本之前變更的專案

GitVersionType

版本類型 (分支、標記或認可) 。 決定如何解譯識別碼

名稱	類型	Description
branch	string	將版本解譯為分支名稱
commit	string	將版本解譯為 SHA1 (認可識別碼)
tag	string	將版本解譯為標籤名稱

WikiCreateParametersV2

Wiki 建立參數。

名稱	類型	Description
mappedPath	string	存放庫內顯示為 Wiki 的資料夾路徑。 ProjectWiki 類型不需要。
name	string	Wiki 名稱。
projectId	string	要在其中建立 Wiki 的專案識別碼。
repositoryId	string	備份 Wiki 的 Git 存放庫識別碼。 ProjectWiki 類型不需要。
type	WikiType	Wiki 的類型。
version	GitVersionDescriptor	Wiki 的版本。 ProjectWiki 類型不需要。

WikiType

Wiki 的類型。

名稱	類型	Description
codeWiki	string	指出 Wiki 是從 Git 存放庫發佈
projectWiki	string	指出已為 Team 專案布建 Wiki

WikiV2

定義 Wiki 資源。

名稱	類型	Description
id	string	Wiki 的識別碼。
mappedPath	string	存放庫內顯示為 Wiki 的資料夾路徑。 ProjectWiki 類型不需要。
name	string	Wiki 名稱。
projectId	string	要在其中建立 Wiki 的專案識別碼。
properties	object	Wiki 的屬性。
remoteUrl	string	Wiki 的遠端 Web URL。
repositoryId	string	備份 Wiki 的 Git 存放庫識別碼。 ProjectWiki 類型不需要。
type	WikiType	Wiki 的類型。
url	string	此 Wiki 的 REST URL。
versions	GitVersionDescriptor[]	Wiki 的版本。