1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/chejiangyi-ApiView

Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

ApiView

Сайт для просмотра документов API .NET, предназначенный для решения задач управления и координации API в процессе распределённого программирования.

  • Автоматическое создание документов API;
  • Удобство отладки API и интеграция с третьими сторонами, применимо к ASP.NET MVC, WCF и WebService;
  • Код и принцип работы просты, что позволяет легко дорабатывать и совершенствовать.

Установочный пакет

Используйте Git для скачивания проекта и откройте директорию «\Установочный пакет\» для прямого использования.

Пример использования Demo

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using BSF.BaseService.OpenApi.Attributes;
using BSF.Extensions;
using BSF.Api;

namespace ApiViewTestWeb.Controllers
{
    public class DemoController : Controller
    {
        //
        // GET: /Demo/
        [OpenDoc("Index", "test method", "параметр описание", "результат описание", "статус результата", "автор", 1.0, 1.0, "замечание")]
        public string Index(int a, string b, float d)
        {
            return a + b.NullToEmpty() + d;
        }
```        [OpenDoc("Каталог товаров магазина V15", "Каталог товаров магазина V15",
                @"token: token (необязательный параметр),
                 ID магазина: shopid,
                 ID категории: categoryid int?,
                 Ключевые слова: keyword,
                 Штрихкод: barcode,
                 Размер страницы: pageSize,
                 Номер страницы: pageIndex",
                @"ID акции: hdxh (int),
                 Штрихкод товара: sptm (string),
                 Наименование товара: spmc (string),
                 Габариты и модель: ggxh (string),
                 Единицы измерения: jldw (string),
                 Изображение товара: sptp (string),
                 Время изменения изображения: sptpxgsj (string),
                 Ориентировочная цена продажи: original_lsj (decimal),
                 Цена продажи: lsj (decimal),
                 Объем продаж: spxl (decimal),
                 Является ли товар частью акции: isActivity (int),
                 Общее количество товаров в акции: hdzsl (decimal),
                 Максимальное количество покупаемых товаров каждым человеком: mrxgsl (decimal)",
                @"-5 недостаточно параметров", "Чжань Жянъюй", 1.5, 1.5, "")]
        public ActionResult List(string shopid, int? categoryid, string keyword, string barcode, long? pageSize, long? pageIndex)
        {
            return Json(new ServiceResult() { code = 1, data = "тестовые данные", msg = "успешно", total = 1 });
        }
    }
}## Инструкция по использованию OpenAPI ##

1. Подключите библиотеки BSF.dll и BSF.BaseService.OpenApi.dll.
2. Добавьте атрибут `OpenDocAttribute` к методам контроллера MVC.
3. Отправьте информацию OpenAPI на сайте AppView.
4. Для применения изменений нажмите кнопку "Перезагрузка" в разделе "Помощь" сайта AppView.

<details>
<summary><strong>Частичный снимок экрана</strong></summary>

![Скриншот](http://static.oschina.net/uploads/space/2016/0602/131829_cIJW_2379842.png)

![Скриншот](http://static.oschina.net/uploads/space/2016/0602/131917_G42x_2379842.png)

![Скриншот](http://static.oschina.net/uploads/space/2016/0602/131944_ijJ1_2379842.png)
</details>

Открытый QQ-чат: .NET Открытые базовые службы **238543768**

*Быстро сделано, надеюсь, что это будет полезно для всех. Если вам интересно, вы можете продолжить его улучшение.*

Автор: Чжэнь Цзянъи

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Просмотр веб-сайта с документацией по интерфейсам API .NET, автоматическое создание документации по API, что удобно для отладки и интеграции сторонних разработчиков. Может применяться в ASP.NET MVC, WCF, WebService; код и принцип работы очень просты, удобны для изменения и доработки. Развернуть Свернуть
Apache-2.0
Отмена

Обновления

Пока нет обновлений

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://api.gitlife.ru/oschina-mirror/chejiangyi-ApiView.git
git@api.gitlife.ru:oschina-mirror/chejiangyi-ApiView.git
oschina-mirror
chejiangyi-ApiView
chejiangyi-ApiView
master