National_Parks_API

国家公园数据库 API（C# ASP .NET 应用程序）

克里斯塔·鲁兹

一个 API 应用程序，用户可以在其中获取和发布有关国家公园的信息，托管在 GitHub 上。最后更新于 2020 年 3 月 4 日。

描述

该应用程序允许用户创建有关国家公园的数据库条目，让他们添加名称、州、公园代码、地区、网站 URL 以及有关公园是否开放的注释。除了放置和删除功能之外，还包括获取和发布公园的功能。

该项目是在 .NET Core 平台上使用 C# 开发的，具有 ASP.NET Core Web 处理功能，使用 MVC 模式库和 SQL 数据库。具体来说，该应用程序是使用实体框架和 MySQL 来创建架构而构建的，并且托管在 GitHub 上。

它是为 Epicodus 第 13 周星期五独立项目创建的，位于 C# 和 .NET 课程“构建 API”第 6 周。

埃皮科多斯技能：

• C#
• MVC 模式（使用 ASP .NET Core 2.2）
• RESTful 路由和 CRUD
• 实体框架迁移
• MySQL 工作台和服务器
• 行为驱动开发（BDD）
• Git 版本控制和 GitHub
• RESTful API 构建

安装/设置

该 API 已完整记录。在 API 文档文档中查找用法和说明。

下载或克隆存储库以在本地运行该程序！

该程序需要.NET Core SDK才能运行。这是在 Mac 或 Windows 10 上安装 .NET 的免费教程。

该程序还使用 SQL 数据库。我们建议使用 MySQL Workbench 来构建您的数据库。这是在 Mac 或 Windows 10 上安装 MySQL WorkBench 和 MySQL Community Server 的免费教程。

• 下载或克隆此存储库。
  • 下载 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 核心 2.2
  • C# 中的服务器端
• MySQL数据库
• 邮差

规格

为州立公园和国家公园创建 API。 API 将列出州立公园和国家公园。以下是要包括的功能：

• 应用程序包括 CRUD 功能并成功返回对 API 调用的响应。
• 应用程序至少包括进一步探索目标之一：身份验证、版本控制、分页、Swagger 文档或 CORS。
• 应用程序有详细的文档记录，包括有关进一步探索的具体文档。
• 完成代码审查的要求后，请考虑添加周一进一步探索中的其他功能。发挥创意并添加其他自定义路线、范围和功能。以下是一些需要考虑的其他可能性：
  • 添加随机返回公园的 RANDOM 端点。
  • 添加第二个接受参数的自定义端点。示例：允许用户按特定公园名称进行搜索的 SEARCH 路线。

您的代码将被审核以实现以下目标：

• 应用程序包括 CRUD 功能并成功返回对 API 调用的响应。

• 应用程序至少包括进一步探索目标之一：身份验证、版本控制、分页、Swagger 文档或 CORS。

• 应用程序有详细的文档记录，包括有关进一步探索的具体文档。

• 提交历史记录清楚地显示了八小时的工作。

已知错误

• 没有已知的错误

支持和联系方式

如果您遇到任何问题或有疑问、想法或疑虑，请与我联系。可以通过 [email protected] 联系我。请随意创建更新拉取请求 -鼓励对代码做出贡献！

执照

版权所有 (c) 2020克里斯塔·鲁兹

该软件根据 MIT 许可证获得许可。

查看许可证详细信息

特此免费授予获得本软件及相关文档文件（“软件”）副本的任何人不受限制地使用本软件，包括但不限于使用、复制、修改、合并的权利、发布、分发、再许可和/或销售软件的副本，并允许向其提供软件的人员这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途的适用性和不侵权的保证。在任何情况下，作者或版权持有者均不对因本软件或本软件中的使用或其他交易而产生或与之相关的任何索赔、损害或其他责任负责，无论是合同、侵权行为还是其他行为。软件。