docs api

README.md

@@ -1,25 +1,5 @@
-<p align="center">
-    <a href="https://github.com/yiisoft" target="_blank">
-        <img src="https://avatars0.githubusercontent.com/u/993323" height="100px">
-    </a>
-    <h1 align="center">Yii 2 Advanced Project Template</h1>
-    <br>
-</p>
 
-Yii 2 Advanced Project Template is a skeleton [Yii 2](http://www.yiiframework.com/) application best for
-developing complex Web applications with multiple tiers.
-
-The template includes three tiers: front end, back end, and console, each of which
-is a separate Yii application.
-
-The template is designed to work in a team development environment. It supports
-deploying the application in different environments.
-
-Documentation is at [docs/guide/README.md](docs/guide/README.md).
-
-[![Latest Stable Version](https://img.shields.io/packagist/v/yiisoft/yii2-app-advanced.svg)](https://packagist.org/packages/yiisoft/yii2-app-advanced)
-[![Total Downloads](https://img.shields.io/packagist/dt/yiisoft/yii2-app-advanced.svg)](https://packagist.org/packages/yiisoft/yii2-app-advanced)
-[![Build Status](https://travis-ci.org/yiisoft/yii2-app-advanced.svg?branch=master)](https://travis-ci.org/yiisoft/yii2-app-advanced)
+[Документация API](/docs/api/main.md "Документация API")
 
 DIRECTORY STRUCTURE
 -------------------

docs/api/main.md

@@ -0,0 +1,57 @@
+# Документация  API
+
+## Навыки
+### Популярные навыки
+`https://guild.craft-group.xyz/api/skills/skills-on-main-page`
+<p>
+    Чтобы получить популярные навыки нужно сделать <b>GET</b> запрос на URL https://guild.craft-group.xyz/api/skills/skills-on-main-page
+</p>
+
+## Профиль
+### Список
+`https://guild.craft-group.xyz/api/profile`
+<p>
+    Для получения списка профилей необходимо отправить <b>GET</b> запрос на URL https://guild.craft-group.xyz/api/profile
+</p>
+<p>
+    Возможные параметры:
+</p>
+<table>
+    <tr>
+        <th>
+            Параметры
+        </th>
+        <th>
+            Значение
+        </th>
+    </tr>
+    <tr>
+        <td>
+            limit
+        </td>
+        <td>
+            Количество профилей, которое вернет сервер при запроск. 
+        </td>
+    </tr>
+    <tr>
+        <td>
+            offset
+        </td>
+        <td>
+            Количество записей на которое нужно отчтупить в списке профилей. 
+        </td>
+    </tr>
+    <tr>
+        <td>
+            skills
+        </td>
+        <td>
+            Идентификаторы навыков по которым нужно отфильтровать профили. 
+        </td>
+    </tr>
+</table>
+<p>
+    Пример запроса:
+</p>
+
+`https://guild.craft-group.xyz/api/profile?limit=5&offset=5&skills=1`