National_Parks_API

API базы данных национальных парков (приложение C# ASP .NET)

Криста Рутц

API-приложение, позволяющее пользователю получать и публиковать информацию о национальных парках, размещенное на GitHub. Последнее обновление 04.03.2020.

Описание

Это приложение позволяет пользователю создавать записи в базе данных о национальных парках, позволяя им добавлять названия, штаты, коды парков, регионы, URL-адреса веб-сайтов и примечания о том, открыт ли парк или нет. В дополнение к функциям размещения и удаления включена возможность получать и размещать парки.

Этот проект был разработан на C# на платформе .NET Core с веб-обработкой ASP.NET Core с использованием библиотек шаблонов MVC и базы данных SQL. В частности, приложение было создано с использованием Entity Framework и MySQL для создания схемы и размещено на GitHub.

Он был создан для пятничного независимого проекта Epicodus на 13-й неделе, на 6-й неделе курса C# и .NET: «Создание API».

Навыки Эпикодуса:

• С#
• Шаблон MVC (с ASP .NET Core 2.2)
• RESTful маршрутизация и CRUD
• Миграции Entity Framework
• MySQL Workbench и сервер
• Разработка, основанная на поведении (BDD)
• Контроль версий Git и GitHub
• Создание RESTful API

Установка/Настройка

Этот API полностью документирован. Использование и пояснения можно найти в документе «Документация по API».

Загрузите или клонируйте репозиторий, чтобы запустить эту программу локально!

Для запуска этой программы требуется .NET Core SDK. Вот бесплатное руководство по установке .NET на Mac или Windows 10.

Эта программа также использует базы данных SQL. Мы рекомендуем использовать MySQL Workbench для создания баз данных. Вот бесплатное руководство по установке MySQL WorkBench и MySQL Community Server на Mac или Windows 10.

• Загрузите или клонируйте этот репозиторий.
  • Чтобы скачать ZIP:
    • Выберите «Загрузить» на сайте репозитория GitHub.
    • После загрузки откройте ZIP-архив и извлеките файлы. Новая папка будет создана как «Week-13-Building-an-API-C-Sharp».
  • Клонировать:
    • Клонируйте из командной строки на рабочий стол: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • Новый каталог будет создан как «Desktop/Week-12-Advanced-Databases-and-Authentication-Project».
• После сохранения файлов локально выполните следующие команды.
  • Перейдите в каталог приложения: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • $ dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• В случае успеха программа начнет работать на вашей консоли.

Используемые технологии

• .NET Core 2.2
  • Серверная часть на C#
• База данных MySQL
• Почтальон

Характеристики

Создайте API для государственных и национальных парков. API будет перечислять государственные и национальные парки. Вот функции, которые следует включить:

• Приложение включает в себя функциональность CRUD и успешно возвращает ответы на вызовы API.
• Приложение включает в себя как минимум одну из целей дальнейшего исследования: аутентификацию, управление версиями, нумерацию страниц, документацию Swagger или CORS.
• Приложение хорошо документировано, включая специальную документацию по дальнейшей разведке.
• После того как вы выполните требования для проверки кода, рассмотрите возможность добавления других функций из дальнейшего исследования в понедельник. Проявите творческий подход и добавьте другие собственные маршруты, области действия и функциональные возможности. Вот еще несколько возможностей, которые стоит рассмотреть:
  • Добавьте СЛУЧАЙНУЮ конечную точку, которая случайным образом возвращает парк.
  • Добавьте вторую пользовательскую конечную точку, которая принимает параметры. Пример: маршрут ПОИСКА, который позволяет пользователям осуществлять поиск по конкретным названиям парков.

Ваш код будет проверен на предмет следующих целей:

• Приложение включает в себя функциональность CRUD и успешно возвращает ответы на вызовы API.

• Приложение включает в себя как минимум одну из целей дальнейшего исследования: аутентификацию, управление версиями, нумерацию страниц, документацию Swagger или CORS.

• Приложение хорошо документировано, включая специальную документацию по дальнейшей разведке.

• История коммитов ясно показывает восемь часов работы.

Известные ошибки

• Нет известных ошибок

Поддержка и контактные данные

Пожалуйста, свяжитесь со мной, если у вас возникнут какие-либо проблемы или возникнут вопросы, идеи или опасения. Со мной можно связаться по адресу [email protected]. Не стесняйтесь создавать запросы на получение обновлений — вклад в код приветствуется!

Лицензия

Copyright (c) 2020 Криста Рутц

Это программное обеспечение распространяется по лицензии MIT.

Посмотреть сведения о лицензии

Настоящим разрешение бесплатно предоставляется любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), на использование Программного обеспечения без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и настоящее уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.