Code Search Results - Fetch Code Search Results

Hizmet:: Search

API Sürümü:: 7.1

Arama metni için bir sonuç kümesi sağlar.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/codesearchresults?api-version=7.1

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

İstek Gövdesi

Veri Akışı Adı	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer (int32)	Atlanacak sonuç sayısı.
$top	integer (int32)	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.
includeSnippet	boolean	Sonuç olarak eşleşen kod parçacığını eklemeyi tercih etmek için bayrak ekleyin. Varsayılan davranış false'tur.
searchText	string	Arama metni.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	CodeSearchResponse	başarılı işlem

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Veri Akışı Adı	Description
vso.code	İşlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkında kaynak kodu ve meta verileri okuma olanağı sağlar. Ayrıca hizmet kancaları aracılığıyla kod arama ve sürüm denetimi olayları hakkında bildirim alma olanağı sağlar.

Örnekler

Örnek isteği

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/codesearchresults?api-version=7.1

{
  "searchText": "CodeSearchController",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "Project": [
      "MyFirstProject"
    ],
    "Repository": [
      "MyFirstProject"
    ],
    "Path": [
      "/"
    ],
    "Branch": [
      "master"
    ],
    "CodeElement": [
      "def",
      "class"
    ]
  },
  "$orderBy": [
    {
      "field": "filename",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Örnek yanıt

Durum kodu:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "CodeSearchController.cs",
      "path": "/CodeSearchController.cs",
      "matches": {
        "content": [
          {
            "charOffset": 1187,
            "length": 20
          },
          {
            "charOffset": 1395,
            "length": 20
          },
          {
            "charOffset": 1686,
            "length": 20
          }
        ],
        "fileName": [
          {
            "charOffset": 0,
            "length": -1
          }
        ]
      },
      "collection": {
        "name": "DefaultCollection"
      },
      "project": {
        "name": "MyFirstProject",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "repository": {
        "name": "MyFirstProject",
        "id": "c1548045-29f6-4354-8114-55ef058be1a3",
        "type": "git"
      },
      "versions": [
        {
          "branchName": "master",
          "changeId": "47e1cc8877baea4b7bb33af803d6cc697914f88b"
        }
      ],
      "contentId": "004898f1ad91c9c2a0f492f2d1174468bc3c84ef"
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "Repository": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "CodeElement": [
      {
        "name": "Class",
        "id": "class",
        "resultCount": 1
      },
      {
        "name": "Comment",
        "id": "comment",
        "resultCount": 1
      },
      {
        "name": "Definition",
        "id": "def",
        "resultCount": 1
      }
    ]
  }
}

Tanımlar

Veri Akışı Adı	Description
CodeResult	Arama yapılan dosyaların ve meta verilerinin bilgilerini içeren kod sonucunu tanımlar.
CodeSearchRequest	Bir kod arama isteği tanımlar.
CodeSearchResponse	Kod arama yanıt öğesini tanımlar.
Collection	Koleksiyonun ayrıntılarını tanımlar.
Project	Projenin ayrıntılarını tanımlar.
Repository	Deponun ayrıntılarını tanımlar.
SortOption	Sonucun nasıl sıralanacağını tanımlar.
Version	Sonuç dosyasının bir sürümüyle ilgili ayrıntıları açıklar.
VersionControlType	Sonuç dosyasının sürüm denetim türü.

CodeResult

Nesne

Arama yapılan dosyaların ve meta verilerinin bilgilerini içeren kod sonucunu tanımlar.

Veri Akışı Adı	Tür	Description
collection	Collection	Sonuç dosyasının koleksiyonu.
contentId	string	Sonuç dosyasının ContentId değeri.
fileName	string	Sonuç dosyasının adı.
matches	object	Sonuç dosyasındaki uzaklıklara isabet eden alan sözlüğü. Anahtar, isabetlerin bulunduğu alanı tanımlar; örneğin: dosya içeriği/dosya adı vb.
path	string	Sonuç dosyasının bulunduğu yol.
project	Project	Sonuç dosyasının projesi.
repository	Repository	Sonuç dosyasının deposu.
versions	Version[]	Sonuç dosyasının sürümleri.

CodeSearchRequest

Nesne

Bir kod arama isteği tanımlar.

Veri Akışı Adı	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer (int32)	Atlanacak sonuç sayısı.
$top	integer (int32)	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.
includeSnippet	boolean	Sonuç olarak eşleşen kod parçacığını eklemeyi tercih etmek için bayrak ekleyin. Varsayılan davranış false'tur.
searchText	string	Arama metni.

CodeSearchResponse

Nesne

Kod arama yanıt öğesini tanımlar.

Veri Akışı Adı	Tür	Description
count	integer (int32)	Eşleşen dosyaların toplam sayısı.
facets	object	Her modelde bir dizi `Filter` nesnesi depolar.
infoCode	integer (int32)	Ek bilgileri gösteren sayısal kod: 0 - Tamam, 1 - Hesap yeniden dizinleniyor, 2 - Hesap dizin oluşturma başlatılmadı, 3 - Geçersiz İstek, 4 - Ön ek joker karakter sorgusu desteklenmiyor, 5 - Kod modelli MultiWords desteklenmiyor, 6 - Hesap ekleniyor, 7 - Hesap ekleniyor veya yeniden dizinleniyor, 8 - En yüksek değer maxresult izin verilen 9'a kırpılıyor - Dallar dizinleniyor, 10 - Model oluşturma etkin değil, 11 - İş öğeleri erişilebilir değil, 19 - Kod türü filtreleri desteklenmeyen tümcecik sorguları, 20 - Kod türü filtreleri desteklenmeyen joker karakter sorguları. Diğer tüm bilgi kodları iç amaçla kullanılır.
results	CodeResult[]	Eşleşen dosyaların listesi.

Collection

Nesne

Koleksiyonun ayrıntılarını tanımlar.

Veri Akışı Adı	Tür	Description
name	string	Koleksiyonun adı.

Project

Nesne

Projenin ayrıntılarını tanımlar.

Veri Akışı Adı	Tür	Description
id	string (uuid)	Projenin kimliği.
name	string	Projenin adı.

Repository

Nesne

Deponun ayrıntılarını tanımlar.

Veri Akışı Adı	Tür	Description
id	string	Deponun kimliği.
name	string	Deponun adı.
type	VersionControlType	Sonuç dosyasının sürüm denetim türü.

SortOption

Nesne

Sonucun nasıl sıralanacağını tanımlar.

Veri Akışı Adı	Tür	Description
field	string	Sıralamanın yapılması gereken alan adı.
sortOrder	string	Sonuçların sıralanması gereken düzen (ASC/DESC).

Version

Nesne

Sonuç dosyasının bir sürümüyle ilgili ayrıntıları açıklar.

Veri Akışı Adı	Tür	Description
branchName	string	Dalın adı.
changeId	string	Bu eşleşmeyle ilişkili verilen daldaki ChangeId.

VersionControlType

Numaralandırma

Sonuç dosyasının sürüm denetim türü.

Değer	Description
git
tfvc
custom	dahili kullanım için.

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?