Skip to content

Commit bf5a5a7

Browse files
authored
Update README.md
1 parent 1fb4f83 commit bf5a5a7

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,42 @@
1-
# The OpenAPI Specification
1+
# OpenAPI Спецификация (Русская редакция)
22

33
![Build Status](https://github.com/OAI/OpenAPI-Specification/workflows/validate-markdown/badge.svg) [![Issue triagers](https://www.codetriage.com/oai/openapi-specification/badges/users.svg)](https://www.codetriage.com/oai/openapi-specification)
44

55
![](https://avatars3.githubusercontent.com/u/16343502?v=3&s=200)
66

77

8-
The OpenAPI Specification is a community-driven open specification within the [OpenAPI Initiative](https://www.openapis.org/), a Linux Foundation Collaborative Project.
8+
Спецификация OpenAPI - это открытая спецификация, поддерживаемая сообществом в рамках [Инициативы OpenAPI](https://www.openapis.org /), совместный проект с Linux Foundation.
99

10-
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
10+
Относительно назначения, OpenAPI рассматривается как универсальный интерфейс для пользователей (клиентов) по взаимодействию с сервисами (серверами). Аналогичен описаниям интерфейса для программирования более низкого уровня. Если спроектирована спецификация для некоторого сервиса, то на её основании можно генерировать исходный код для библиотек клиентских приложений, текстовую документацию для пользователей, варианты тестирования и др. Для этих действий имеется большой набор инструментов для различных языков программирования и платформ.
1111

12-
Use cases for machine-readable API definition documents include, but are not limited to: interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an APIs services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.
12+
OpenAPI представляет собой формализованную спецификацию и полноценный фреймворк для описания, создания, использования и визуализации веб-сервисов REST. Задачей является позволить клиентским системам и документации синхронизировать свои обновления с изменениями на сервере. Это достигается тем, что методы, параметры, модели и другие элементы посредством OpenAPI интегрируются с программным обеспечением сервера и всё время с ним синхронизируются
1313

14-
The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service – the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI – this specification is not intended to cover every possible style of HTTP APIs, but does include support for [REST APIs](https://en.wikipedia.org/wiki/Representational_state_transfer). The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a HTTP API.
14+
Документы OpenAPI описывают сервис API и представлены в форматах YAML или JSON. Эти документы могут либо создаваться и обслуживаться статически (FirstAPI), либо создаваться динамически из приложения (CodeFirst).
1515

16-
This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project.
16+
Спецификация OpenAPI не требует перезаписи существующих API. Это не требует привязки какого–либо программного обеспечения к сервису - описываемый сервис может даже не принадлежать создателю его описания. Однако требует, чтобы возможности сервиса были описаны в структуре спецификации OpenAPI. Не все службы могут быть описаны с помощью OpenAPI – эта спецификация не предназначена для охвата всех возможных вариантов API HTTP, но включает поддержку [API REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Спецификация OpenAPI не предписывает конкретный процесс разработки, такой как сначала описание (First-API, Design-First) или сначала код (Code-First).
1717

18-
## Current Version - 3.1.0
18+
Этот GitHub проект может является отправной точкой для OpenAPI. Здесь вы найдете необходимую информацию об спецификации OpenAPI, простые примеры того, как она выглядит, и некоторую общую информацию о проекте, на русском языке.
1919

20-
The current version of the OpenAPI specification is [OpenAPI Specification 3.1.0](versions/3.1.0.md).
20+
## Текущая версия - 3.1.0
2121

22-
### Previous Versions
22+
Текущая версия OpenAPI спецификации [OpenAPI Specification 3.1.0](versions/3.1.0.md).
2323

24-
This repository also contains all [previous versions](versions).
24+
### Предыдущая версия
25+
26+
Этот репозиторий так же содержит все [предыдущие версии](versions).
2527

2628
Each folder in this repository, such as [examples](examples) and [schemas](schemas), should contain folders pertaining to the current and previous versions of the specification.
2729

2830
## See It in Action
2931

3032
If you just want to see it work, check out the [list of current examples](examples).
3133

32-
## Tools and Libraries
34+
## Инструменты и библиотеки
3335

3436
Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing
3537
[list of implementations](IMPLEMENTATIONS.md).
3638

37-
## Participation
39+
## Участие
3840

3941
The current process for development of the OpenAPI Specification is described in
4042
[Development Guidelines](DEVELOPMENT.md).
@@ -52,8 +54,8 @@ The OpenAPI Initiative encourages participation from individuals and companies a
5254

5355
Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.
5456

55-
## Licensing
57+
## Лицензия
5658

57-
See: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/main/LICENSE)
59+
Смотрите: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/main/LICENSE)
5860

5961
![Analytics](https://ga-beacon.appspot.com/UA-831873-42/readme.md?pixel)

0 commit comments

Comments
 (0)