Development References

References

This page outlines some links and information to keep in mind when developing in the Urban Engine API

Azure Postgre SQL

• Azure Database for PostgreSQL
• Refer to documentation at Azure Database for PostgreSQL Documentation
• More details to be added once setup for project

API Versioning

• the Web API services take advantage of API versioning via ASP.NET API Versioning
• this allows multiple versions of endpoints to be supported without breaking the API for consumers
• reference the GitHub repo at ASP.NET API Versioning
• example on the wiki followed to integrate with Swagger

Application Insights

• Application Insights is setup in the source code to help "monitor the web application for availability, performance, and usage."
• In the appsettings.json file an entry exists for ApplicationInsights where an InstrumentationKey must be specified in order to log any telemetry to AppInsights for the application
• Refer to documentation at Application Insights for ASP.NET Core

Logging

• The logging API supported by ASP.NET Core is a built in provider that works with a variety of logging providers.
• Currently only Console and Debug are setup in the source code but additonal providers may be added at a later time
• Refer to documentation at Logging in ASP.NET Core for examples and details
• The Logging section of the appsettings.json file controls various logging related settings

Swagger

• Swagger is used for generating API documentation about the Web API services
• Refer to documentation at Get started with Swashbuckle and ASP.NET Core on details for how this works
• Add XML documentation to any class, and class members (methods, properties, etc) to see this in the swagger generated documentation
• Swagger gives the ability to call an API endpoint directly from the swagger doc