search
    search
    • 主页搜索
      POST
    • 主页搜索数据统计
      POST
    • 联想搜索词
      POST
    • 通用筛选
      POST
    • 通用筛选(type指定)
      POST
    • 通用所有标签
      POST
    • 文档内查询
      POST
    • 搜索词补全
      POST

      主页搜索

      POST
      /search/docs

      请求参数

      Body 参数application/json
      keyword
      string 
      必需
      搜索词(字符串长度限制为100,内容需符合该正则表达式 ^[\u4E00-\u9FA5A-Za-z0-9.())
      page
      integer 
      必需
      搜索结果分页页码 (值限制为1 ~ 1000,不传默认为1)
      pageSize
      integer 
      必需
      搜索结果分页每页数量(值限制为5 ~ 50,不传默认为10)
      lang
      string 
      必需
      搜索内容的语言(值只能为 zh, en ZH ,EN)
      type
      string 
      必需
      搜索内容大分类,例如docs, news ,blog(长度限制为15)
      limit
      array [object {2}] 
      可选
      多版本文档筛选使用,可以根据limit决定在这次搜索中保留那些版本文档
      type
      string 
      需要保留的内容类型
      可选
      version
      string 
      可选
      需要保留的版本,比如写8.0 就会在结果中只显示8.0版本内容
      filter
      array [object] 
      可选
      过滤器,指定那些类型版本文档,其他内容过滤掉
      示例
      {
          "keyword": "openeuler",
          "page": 1,
          "pageSize": 12,
          "lang": "en",
          "type": "",
          "limit": [
              {
                  "type": "docs",
                  "version": "23.09"
              }
          ],
          "filter": [
            {
              
            }
          ]
      }

      示例代码

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST '/search/docs' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "keyword": "openeuler",
          "page": 1,
          "pageSize": 12,
          "lang": "en",
          "type": "",
          "limit": [
              {
                  "type": "docs",
                  "version": "23.09"
              }
          ],
          "filter": [
            {
              
            }
          ]
      }'

      返回响应

      🟢200成功
      application/json
      Body
      status
      integer 
      必需
      状态码,不为200全部是服务查询失败
      msg
      string 
      服务错误返回信息
      必需
      obj
      object 
      服务数据
      必需
      records
      array [object {8}] 
      必需
      pageSize
      integer 
      必需
      page
      integer 
      必需
      keyword
      string 
      必需
      示例
      {
          "status": 200,
          "msg": "查询成功",
          "obj": {
              "records": [
                  {
                      "path": "https://eur.openeuler.openatom.cn/coprs/",
                      "secondaryTitle": null,
                      "textContent": "",
                      "title": "<span>openEuler</span> User Repo",
                      "lang": "en",
                      "type": "service"
                  },
                  {
                      "path": "https://radiatest.openeuler.org",
                      "secondaryTitle": "Testing management platform developed based on openEuler",
                      "textContent": "Testing management platform developed based on <span>openEuler</span><br>",
                      "title": "EulerTest",
                      "lang": "en",
                      "type": "service"
                  },
                  {
                      "path": "https://gitee.com/openeuler/oecp/",
                      "secondaryTitle": "Os compare anlyze tool",
                      "textContent": "Os compare anlyze tool Focus on the <span>openEuler</span> core and basic packages to ensure that the core features<br>",
                      "title": "oecp",
                      "lang": "en",
                      "type": "service"
                  },
                  {
                      "path": "https://pkgmanage.openeuler.org/Packagemanagement",
                      "secondaryTitle": "A query tool that manages OS software package information and dependencies",
                      "textContent": "software when introducing, updating and deleting software packages;Package Management ;https://pkgmanage.<span>openeuler</span>.org<br>",
                      "title": "Package-Management",
                      "lang": "en",
                      "type": "service"
                  },
                  {
                      "path": "en/compatibility/",
                      "articleName": "index.html",
                      "textContent": "Compatibility List OS All Architecture All CPU All No Data OS All Architecture All Type All No Data <span>openEuler</span><br>For details, see the Overall Introduction to the <span>openEuler</span> Hardware Compatibility Test Server No Data<br><span>openEuler</span> provides a complete process and tools for hardware compatibility test.<br>For details, see the Overall Introduction to the <span>openEuler</span> Hardware Compatibility Test Card No Data <span>openEuler</span><br>Got it How likely are you to recommend the <span>openEuler</span> Community to others?<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span>"
                  },
                  {
                      "path": "en/sig/sig-guidance/",
                      "articleName": "index.html",
                      "textContent": "Set Up 01 FindIndividuals or companies find two or three persons with common goals in the <span>openEuler</span> community<br>to discuss and set up a SIG, which aims to maintain a specific type of software package in the <span>openEuler</span><br>Got it How likely are you to recommend the <span>openEuler</span> Community to others?<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span>"
                  },
                  {
                      "path": "en/sig/sig-list/",
                      "articleName": "index.html",
                      "textContent": "SIG The <span>openEuler</span> community is organized based on Special Interest Groups (SIGs) to better manage and<br>manage each group, and members can contribute to the quality and the output of deliverables for the <span>openEuler</span><br>Got it How likely are you to recommend the <span>openEuler</span> Community to others?<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span>"
                  },
                  {
                      "path": "en/sig/sig-detail/",
                      "articleName": "index.html",
                      "textContent": "Got it How likely are you to recommend the <span>openEuler</span> Community to others?<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span>"
                  },
                  {
                      "path": "en/interaction/summit-list/summit2023/",
                      "articleName": "index.html",
                      "textContent": "Committee <span>openEuler</span> Summit 2023 Keynote Jiang Dayong Governing Board Chairperson <span>openEuler</span> Committee<br>maintainer Xie Xiuqi <span>openEuler</span> maintainer Lu Yan Technical Director Software Chen Yaqiang <span>openEuler</span><br>maintainer Che Mingdao <span>openEuler</span> maintainer Zheng Zhenyu <span>openEuler</span> maintainer Wu Fengguang <span>openEuler</span><br>maintainer Ren Wei <span>openEuler</span> Technical Committee Member Zhu Jianwei <span>openEuler</span> Security Committee Member<br>Luo Yukai <span>openEuler</span> Security Committee Member Liu Hao <span>openEuler</span> maintainer Yu Yang R&D Director TongTech<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span> Summit 2023"
                  },
                  {
                      "path": "en/docs/23.09/docs/desktop/Install_Cinnamon",
                      "articleName": "Install_Cinnamon.md",
                      "textContent": "Installing Cinnamon on <span>openEuler</span> Cinnamon is the most commonly used desktop environment running in Unix-like<br>Download the <span>openEuler</span> ISO file, install the system, and update the software source.<br>",
                      "lang": "en",
                      "type": "docs",
                      "title": "Installing Cinnamon on <span>openEuler</span>",
                      "version": "23.09"
                  },
                  {
                      "path": "en/docs/23.09/docs/desktop/installing-GNOME",
                      "articleName": "installing-GNOME.md",
                      "textContent": "Installing GNOME on <span>openEuler</span> GNOME is a desktop environment for Unix-like operating systems.<br>Download the <span>openEuler</span> ISO image, install the system, and update the software source.<br>",
                      "lang": "en",
                      "type": "docs",
                      "title": "Installing GNOME on <span>openEuler</span>",
                      "version": "23.09"
                  },
                  {
                      "path": "en/community/certification-services/",
                      "articleName": "index.html",
                      "textContent": "<span>openEuler</span>-HCIX Certification Download Certificates <span>openEuler</span>-HCIA, <span>openEuler</span>-HCIP and <span>openEuler</span>-HCIE<br>are the capability certifications at different levels recognized by the <span>openEuler</span> community.<br>obtaining any of these certificates, click the following items to sign up for the trainings and tests. <span>openEuler</span>-HCIA<br>Certified EngineerView more <span>openEuler</span>-HCIP Certified Senior EngineeComing soon <span>openEuler</span>-HCIE Certified<br>Got it How likely are you to recommend the <span>openEuler</span> Community to others?<br>",
                      "lang": "en",
                      "type": "other",
                      "title": "<span>openEuler</span>-HCIX Certification"
                  }
              ],
              "pageSize": 12,
              "page": 1,
              "keyword": "openeuler"
          }
      }
      修改于 2024-01-30 07:48:01
      下一页
      主页搜索数据统计
      Built with