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 許可證獲得許可。

查看許可證詳細信息

特此免費授予任何獲得本軟體及相關文件文件（「軟體」）副本的人不受限制地使用本軟體，包括但不限於使用、複製、修改、合併的權利、發布、散佈、再授權和/或銷售軟體的副本，並允許向其提供軟體的人員這樣做，但須滿足以下條件：

上述版權聲明和本授權聲明應包含在本軟體的所有副本或主要部分中。

本軟體以「現況」提供，不提供任何明示或暗示的保證，包括但不限於適銷性、特定用途的適用性和不侵權的保證。 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE軟體.