Проект

Общее

Профиль

Загрузить (2,37 КБ)

Swagger SRU » swagger-sru.yaml

Sergey Dostovalov, 23.09.2016 17:20

 
---
swagger: '2.0'
info:
version: 1.0.0
title: |
Протокол SRU
description: |
Полное описание http://docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part3-sru2.0/searchRetrieve-v1.0-os-part3-sru2.0.pdf
schemes:
- https
consumes:
- application/json
- application/xml
produces:
- application/json
- application/opac+json
- application/xml
- application/opac+xml
host: idp.library.spbstu.ru
basePath: /rrs-web
paths:
/db/{database}:
parameters:
- name: database
in: path
type: string
required: true
get:
parameters:
- name: query
in: query
type: string
required: true
description: |
запроc на языке pqf или cql.
Пример PQF: @attrset bib-1 @attr 1=4 "java" .
Пример CQL: dc.title=java
- name: queryType
in: query
type: string
enum:
- pqf
- cql
default: cql
required: true
- name: startRecord
in: query
type: integer
required: false
default: 1
description: индекс записи для извления. Начинается с 1
- name: maximumRecords
in: query
required: false
type: integer
default: 10
description: максимальное количество записей в ответе
- name: recordSchema
in: query
required: false
type: string
enum:
- rusmarc
- usmarc
- unimarc
- dc
description: схема записи
responses:
200:
description: Поиск в базе
/db/{database}/{recordId}:
parameters:
- name: database
in: path
type: string
required: true
description: Например books
- name: recordId
in: path
type: string
required: true
description: Должен быть urlencoded. Напирисер RU%5CSPSTU%5Cbooks%5C50037
get:
parameters:
- name: recordSchema
in: query
type: string
required: false
description: Формат запии
responses:
200:
description: получение записи
    (1-1/1)