├── .gitignore
├── BaldBeardedBuilder.HATEOAS.sln
├── LICENSE
├── README.md
└── src
├── BaldBeardedBuilder.HATEOAS.Lib
├── BaldBeardedBuilder.HATEOAS.Lib.csproj
├── Data
│ └── BBBContext.cs
└── Entities
│ ├── Address.cs
│ └── Client.cs
└── BaldBeardedBuilder.HATEOAS
├── AutoMapping.cs
├── BaldBeardedBuilder.HATEOAS.csproj
├── Controllers
├── AddressController.cs
├── ClientController.cs
├── HomeController.cs
└── RestControllerBase.cs
├── Models
├── AddressModel.cs
├── ClientModel.cs
├── Link.cs
├── RestModelBase.cs
└── RootModel.cs
├── Program.cs
├── Properties
└── launchSettings.json
├── Startup.cs
├── appsettings.Development.json
└── appsettings.json
/.gitignore:
--------------------------------------------------------------------------------
1 | ## Ignore Visual Studio temporary files, build results, and
2 | ## files generated by popular Visual Studio add-ons.
3 | ##
4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
5 |
6 | # User-specific files
7 | *.rsuser
8 | *.suo
9 | *.user
10 | *.userosscache
11 | *.sln.docstates
12 |
13 | # User-specific files (MonoDevelop/Xamarin Studio)
14 | *.userprefs
15 |
16 | # Mono auto generated files
17 | mono_crash.*
18 |
19 | # Build results
20 | [Dd]ebug/
21 | [Dd]ebugPublic/
22 | [Rr]elease/
23 | [Rr]eleases/
24 | x64/
25 | x86/
26 | [Aa][Rr][Mm]/
27 | [Aa][Rr][Mm]64/
28 | bld/
29 | [Bb]in/
30 | [Oo]bj/
31 | [Ll]og/
32 | [Ll]ogs/
33 |
34 | # Visual Studio 2015/2017 cache/options directory
35 | .vs/
36 | # Uncomment if you have tasks that create the project's static files in wwwroot
37 | #wwwroot/
38 |
39 | # Visual Studio 2017 auto generated files
40 | Generated\ Files/
41 |
42 | # MSTest test Results
43 | [Tt]est[Rr]esult*/
44 | [Bb]uild[Ll]og.*
45 |
46 | # NUnit
47 | *.VisualState.xml
48 | TestResult.xml
49 | nunit-*.xml
50 |
51 | # Build Results of an ATL Project
52 | [Dd]ebugPS/
53 | [Rr]eleasePS/
54 | dlldata.c
55 |
56 | # Benchmark Results
57 | BenchmarkDotNet.Artifacts/
58 |
59 | # .NET Core
60 | project.lock.json
61 | project.fragment.lock.json
62 | artifacts/
63 |
64 | # StyleCop
65 | StyleCopReport.xml
66 |
67 | # Files built by Visual Studio
68 | *_i.c
69 | *_p.c
70 | *_h.h
71 | *.ilk
72 | *.meta
73 | *.obj
74 | *.iobj
75 | *.pch
76 | *.pdb
77 | *.ipdb
78 | *.pgc
79 | *.pgd
80 | *.rsp
81 | *.sbr
82 | *.tlb
83 | *.tli
84 | *.tlh
85 | *.tmp
86 | *.tmp_proj
87 | *_wpftmp.csproj
88 | *.log
89 | *.vspscc
90 | *.vssscc
91 | .builds
92 | *.pidb
93 | *.svclog
94 | *.scc
95 |
96 | # Chutzpah Test files
97 | _Chutzpah*
98 |
99 | # Visual C++ cache files
100 | ipch/
101 | *.aps
102 | *.ncb
103 | *.opendb
104 | *.opensdf
105 | *.sdf
106 | *.cachefile
107 | *.VC.db
108 | *.VC.VC.opendb
109 |
110 | # Visual Studio profiler
111 | *.psess
112 | *.vsp
113 | *.vspx
114 | *.sap
115 |
116 | # Visual Studio Trace Files
117 | *.e2e
118 |
119 | # TFS 2012 Local Workspace
120 | $tf/
121 |
122 | # Guidance Automation Toolkit
123 | *.gpState
124 |
125 | # ReSharper is a .NET coding add-in
126 | _ReSharper*/
127 | *.[Rr]e[Ss]harper
128 | *.DotSettings.user
129 |
130 | # TeamCity is a build add-in
131 | _TeamCity*
132 |
133 | # DotCover is a Code Coverage Tool
134 | *.dotCover
135 |
136 | # AxoCover is a Code Coverage Tool
137 | .axoCover/*
138 | !.axoCover/settings.json
139 |
140 | # Visual Studio code coverage results
141 | *.coverage
142 | *.coveragexml
143 |
144 | # NCrunch
145 | _NCrunch_*
146 | .*crunch*.local.xml
147 | nCrunchTemp_*
148 |
149 | # MightyMoose
150 | *.mm.*
151 | AutoTest.Net/
152 |
153 | # Web workbench (sass)
154 | .sass-cache/
155 |
156 | # Installshield output folder
157 | [Ee]xpress/
158 |
159 | # DocProject is a documentation generator add-in
160 | DocProject/buildhelp/
161 | DocProject/Help/*.HxT
162 | DocProject/Help/*.HxC
163 | DocProject/Help/*.hhc
164 | DocProject/Help/*.hhk
165 | DocProject/Help/*.hhp
166 | DocProject/Help/Html2
167 | DocProject/Help/html
168 |
169 | # Click-Once directory
170 | publish/
171 |
172 | # Publish Web Output
173 | *.[Pp]ublish.xml
174 | *.azurePubxml
175 | # Note: Comment the next line if you want to checkin your web deploy settings,
176 | # but database connection strings (with potential passwords) will be unencrypted
177 | *.pubxml
178 | *.publishproj
179 |
180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to
181 | # checkin your Azure Web App publish settings, but sensitive information contained
182 | # in these scripts will be unencrypted
183 | PublishScripts/
184 |
185 | # NuGet Packages
186 | *.nupkg
187 | # NuGet Symbol Packages
188 | *.snupkg
189 | # The packages folder can be ignored because of Package Restore
190 | **/[Pp]ackages/*
191 | # except build/, which is used as an MSBuild target.
192 | !**/[Pp]ackages/build/
193 | # Uncomment if necessary however generally it will be regenerated when needed
194 | #!**/[Pp]ackages/repositories.config
195 | # NuGet v3's project.json files produces more ignorable files
196 | *.nuget.props
197 | *.nuget.targets
198 |
199 | # Microsoft Azure Build Output
200 | csx/
201 | *.build.csdef
202 |
203 | # Microsoft Azure Emulator
204 | ecf/
205 | rcf/
206 |
207 | # Windows Store app package directories and files
208 | AppPackages/
209 | BundleArtifacts/
210 | Package.StoreAssociation.xml
211 | _pkginfo.txt
212 | *.appx
213 | *.appxbundle
214 | *.appxupload
215 |
216 | # Visual Studio cache files
217 | # files ending in .cache can be ignored
218 | *.[Cc]ache
219 | # but keep track of directories ending in .cache
220 | !?*.[Cc]ache/
221 |
222 | # Others
223 | ClientBin/
224 | ~$*
225 | *~
226 | *.dbmdl
227 | *.dbproj.schemaview
228 | *.jfm
229 | *.pfx
230 | *.publishsettings
231 | orleans.codegen.cs
232 |
233 | # Including strong name files can present a security risk
234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424)
235 | #*.snk
236 |
237 | # Since there are multiple workflows, uncomment next line to ignore bower_components
238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
239 | #bower_components/
240 |
241 | # RIA/Silverlight projects
242 | Generated_Code/
243 |
244 | # Backup & report files from converting an old project file
245 | # to a newer Visual Studio version. Backup files are not needed,
246 | # because we have git ;-)
247 | _UpgradeReport_Files/
248 | Backup*/
249 | UpgradeLog*.XML
250 | UpgradeLog*.htm
251 | ServiceFabricBackup/
252 | *.rptproj.bak
253 |
254 | # SQL Server files
255 | *.mdf
256 | *.ldf
257 | *.ndf
258 |
259 | # Business Intelligence projects
260 | *.rdl.data
261 | *.bim.layout
262 | *.bim_*.settings
263 | *.rptproj.rsuser
264 | *- [Bb]ackup.rdl
265 | *- [Bb]ackup ([0-9]).rdl
266 | *- [Bb]ackup ([0-9][0-9]).rdl
267 |
268 | # Microsoft Fakes
269 | FakesAssemblies/
270 |
271 | # GhostDoc plugin setting file
272 | *.GhostDoc.xml
273 |
274 | # Node.js Tools for Visual Studio
275 | .ntvs_analysis.dat
276 | node_modules/
277 |
278 | # Visual Studio 6 build log
279 | *.plg
280 |
281 | # Visual Studio 6 workspace options file
282 | *.opt
283 |
284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
285 | *.vbw
286 |
287 | # Visual Studio LightSwitch build output
288 | **/*.HTMLClient/GeneratedArtifacts
289 | **/*.DesktopClient/GeneratedArtifacts
290 | **/*.DesktopClient/ModelManifest.xml
291 | **/*.Server/GeneratedArtifacts
292 | **/*.Server/ModelManifest.xml
293 | _Pvt_Extensions
294 |
295 | # Paket dependency manager
296 | .paket/paket.exe
297 | paket-files/
298 |
299 | # FAKE - F# Make
300 | .fake/
301 |
302 | # CodeRush personal settings
303 | .cr/personal
304 |
305 | # Python Tools for Visual Studio (PTVS)
306 | __pycache__/
307 | *.pyc
308 |
309 | # Cake - Uncomment if you are using it
310 | # tools/**
311 | # !tools/packages.config
312 |
313 | # Tabs Studio
314 | *.tss
315 |
316 | # Telerik's JustMock configuration file
317 | *.jmconfig
318 |
319 | # BizTalk build output
320 | *.btp.cs
321 | *.btm.cs
322 | *.odx.cs
323 | *.xsd.cs
324 |
325 | # OpenCover UI analysis results
326 | OpenCover/
327 |
328 | # Azure Stream Analytics local run output
329 | ASALocalRun/
330 |
331 | # MSBuild Binary and Structured Log
332 | *.binlog
333 |
334 | # NVidia Nsight GPU debugger configuration file
335 | *.nvuser
336 |
337 | # MFractors (Xamarin productivity tool) working folder
338 | .mfractor/
339 |
340 | # Local History for Visual Studio
341 | .localhistory/
342 |
343 | # BeatPulse healthcheck temp database
344 | healthchecksdb
345 |
346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017
347 | MigrationBackup/
348 |
349 | # Ionide (cross platform F# VS Code tools) working folder
350 | .ionide/
351 |
--------------------------------------------------------------------------------
/BaldBeardedBuilder.HATEOAS.sln:
--------------------------------------------------------------------------------
1 |
2 | Microsoft Visual Studio Solution File, Format Version 12.00
3 | # Visual Studio Version 16
4 | VisualStudioVersion = 16.0.29326.143
5 | MinimumVisualStudioVersion = 10.0.40219.1
6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "BaldBeardedBuilder.HATEOAS", "src\BaldBeardedBuilder.HATEOAS\BaldBeardedBuilder.HATEOAS.csproj", "{9A44A5BA-F582-4C99-9858-0E336375004E}"
7 | EndProject
8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BaldBeardedBuilder.HATEOAS.Lib", "src\BaldBeardedBuilder.HATEOAS.Lib\BaldBeardedBuilder.HATEOAS.Lib.csproj", "{5554A8BD-98A5-4117-809B-69DF8A07C212}"
9 | EndProject
10 | Global
11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution
12 | Debug|Any CPU = Debug|Any CPU
13 | Release|Any CPU = Release|Any CPU
14 | EndGlobalSection
15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution
16 | {9A44A5BA-F582-4C99-9858-0E336375004E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
17 | {9A44A5BA-F582-4C99-9858-0E336375004E}.Debug|Any CPU.Build.0 = Debug|Any CPU
18 | {9A44A5BA-F582-4C99-9858-0E336375004E}.Release|Any CPU.ActiveCfg = Release|Any CPU
19 | {9A44A5BA-F582-4C99-9858-0E336375004E}.Release|Any CPU.Build.0 = Release|Any CPU
20 | {5554A8BD-98A5-4117-809B-69DF8A07C212}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
21 | {5554A8BD-98A5-4117-809B-69DF8A07C212}.Debug|Any CPU.Build.0 = Debug|Any CPU
22 | {5554A8BD-98A5-4117-809B-69DF8A07C212}.Release|Any CPU.ActiveCfg = Release|Any CPU
23 | {5554A8BD-98A5-4117-809B-69DF8A07C212}.Release|Any CPU.Build.0 = Release|Any CPU
24 | EndGlobalSection
25 | GlobalSection(SolutionProperties) = preSolution
26 | HideSolutionNode = FALSE
27 | EndGlobalSection
28 | GlobalSection(ExtensibilityGlobals) = postSolution
29 | SolutionGuid = {D82CB469-C31A-40EC-8C72-90D74CFC3360}
30 | EndGlobalSection
31 | EndGlobal
32 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2019 Michael Jolley
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Adding basic HATEOAS support to ASP.NET Core APIs
2 |
3 | This is a sample repo designed to show how to implement rudimentary HATEOAS support
4 | to an ASP.NET Core API. It was built on ASP.NET Core 3.0 and utilizes Entity Framework Core
5 | communicating with an in-memory database.
6 |
7 | Read more about how this repo was implemented at https://baldbeardedbuilder.com/.
8 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS.Lib/BaldBeardedBuilder.HATEOAS.Lib.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | netstandard2.0
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS.Lib/Data/BBBContext.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using Microsoft.EntityFrameworkCore;
3 |
4 | using BaldBeardedBuilder.HATEOAS.Lib.Entities;
5 |
6 | namespace BaldBeardedBuilder.HATEOAS.Lib.Data
7 | {
8 | public class BBBContext: DbContext
9 | {
10 | public BBBContext()
11 | { }
12 |
13 | public BBBContext(DbContextOptions options)
14 | : base(options)
15 | { }
16 |
17 | public void SeedData()
18 | {
19 | Client client1 = new Client()
20 | {
21 | Id = Guid.NewGuid(),
22 | Name = "Clause Inc."
23 | };
24 | Client client2 = new Client()
25 | {
26 | Id = Guid.NewGuid(),
27 | Name = "GrinchCo"
28 | };
29 |
30 | client1.Addresses.Add(new Address()
31 | {
32 | Id = Guid.NewGuid(),
33 | StreetAddress = "1 Candy Cane Lane",
34 | City = "North Pole",
35 | PostalCode = "NP1225"
36 | });
37 |
38 | client2.Addresses.Add(new Address()
39 | {
40 | Id = Guid.NewGuid(),
41 | StreetAddress = "543 Sad Sack Square",
42 | City = "Whoville",
43 | PostalCode = "IB1337"
44 | });
45 |
46 | this.Clients.AddRange(client1, client2);
47 | this.SaveChanges();
48 | }
49 |
50 | public virtual DbSet Clients { get; set; }
51 | public virtual DbSet Addresses { get; set; }
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS.Lib/Entities/Address.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.ComponentModel.DataAnnotations;
3 |
4 | namespace BaldBeardedBuilder.HATEOAS.Lib.Entities
5 | {
6 | public class Address
7 | {
8 | [Key]
9 | public Guid Id { get; set; }
10 | public string StreetAddress { get; set; }
11 | public string City { get; set; }
12 | public string PostalCode { get; set; }
13 | public Guid ClientId { get; set; }
14 |
15 | public virtual Client Client { get; set; }
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS.Lib/Entities/Client.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.ComponentModel.DataAnnotations;
4 |
5 | namespace BaldBeardedBuilder.HATEOAS.Lib.Entities
6 | {
7 | public class Client
8 | {
9 | public Client()
10 | {
11 | this.Addresses = new HashSet();
12 | }
13 |
14 | [Key]
15 | public Guid Id { get; set; }
16 | public string Name { get; set; }
17 |
18 | public virtual ICollection Addresses { get; set; }
19 | }
20 | }
21 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/AutoMapping.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | using AutoMapper;
4 | using BaldBeardedBuilder.HATEOAS.Lib.Entities;
5 | using BaldBeardedBuilder.HATEOAS.Models;
6 |
7 | namespace BaldBeardedBuilder.HATEOAS
8 | {
9 | public class AutoMapping : Profile
10 | {
11 | public AutoMapping()
12 | {
13 | CreateMap();
14 | CreateMap();
15 | }
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/BaldBeardedBuilder.HATEOAS.csproj:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | netcoreapp3.0
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Controllers/AddressController.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using System.Threading.Tasks;
5 | using Microsoft.AspNetCore.Mvc;
6 | using Microsoft.AspNetCore.Mvc.Infrastructure;
7 | using Microsoft.Extensions.Logging;
8 |
9 | using AutoMapper;
10 |
11 | using BaldBeardedBuilder.HATEOAS.Lib.Data;
12 | using BaldBeardedBuilder.HATEOAS.Models;
13 | using BaldBeardedBuilder.HATEOAS.Lib.Entities;
14 |
15 | namespace BaldBeardedBuilder.HATEOAS.Controllers
16 | {
17 | [ApiController]
18 | [Route("api/addresses")]
19 | public class AddressController : RestControllerBase
20 | {
21 | private readonly ILogger _logger;
22 | private readonly BBBContext _bbbContext;
23 |
24 | public AddressController(ILogger logger, IActionDescriptorCollectionProvider actionDescriptorCollectionProvider, BBBContext bbbContext, IMapper mapper)
25 | : base(actionDescriptorCollectionProvider, mapper)
26 | {
27 | _logger = logger;
28 | _bbbContext = bbbContext;
29 | }
30 |
31 | [HttpGet(Name = "GetAddresses")]
32 | public IActionResult GetAddresses()
33 | {
34 | IEnumerable addresses = _bbbContext.Addresses;
35 | IEnumerable addressModels = addresses.Select(f => RestfulAddress(f));
36 |
37 | return Ok(addressModels);
38 | }
39 |
40 | [HttpGet("{id}", Name = "GetAddressAsync")]
41 | public async Task GetAddressAsync(Guid id)
42 | {
43 | if (id == Guid.Empty)
44 | {
45 | return BadRequest();
46 | }
47 |
48 | Address address = await _bbbContext.Addresses.FindAsync(id);
49 |
50 | if (address == null)
51 | {
52 | return NotFound();
53 | }
54 |
55 | return Ok(RestfulAddress(address));
56 | }
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Controllers/ClientController.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using System.Threading.Tasks;
5 | using Microsoft.AspNetCore.Mvc;
6 | using Microsoft.AspNetCore.Mvc.Infrastructure;
7 | using Microsoft.Extensions.Logging;
8 |
9 | using AutoMapper;
10 |
11 | using BaldBeardedBuilder.HATEOAS.Lib.Data;
12 | using BaldBeardedBuilder.HATEOAS.Models;
13 | using BaldBeardedBuilder.HATEOAS.Lib.Entities;
14 |
15 | namespace BaldBeardedBuilder.HATEOAS.Controllers
16 | {
17 | [ApiController]
18 | [Route("api/clients")]
19 | public class ClientController : RestControllerBase
20 | {
21 | private readonly ILogger _logger;
22 | private readonly BBBContext _bbbContext;
23 |
24 | public ClientController(ILogger logger, IActionDescriptorCollectionProvider actionDescriptorCollectionProvider, BBBContext bbbContext, IMapper mapper)
25 | : base(actionDescriptorCollectionProvider, mapper)
26 | {
27 | _logger = logger;
28 | _bbbContext = bbbContext;
29 | }
30 |
31 | [HttpGet(Name = "GetClients")]
32 | public IActionResult GetClients()
33 | {
34 | IEnumerable clients = _bbbContext.Clients;
35 | IEnumerable clientModels = clients.Select(f => RestfulClient(f));
36 |
37 | return Ok(clientModels);
38 | }
39 |
40 | [HttpGet("{id}", Name = "GetClientAsync")]
41 | public async Task GetClientAsync(Guid id)
42 | {
43 | if (id == Guid.Empty)
44 | {
45 | return BadRequest();
46 | }
47 |
48 | Client client = await _bbbContext.Clients.FindAsync(id);
49 |
50 | if (client == null)
51 | {
52 | return NotFound();
53 | }
54 |
55 | return Ok(RestfulClient(client));
56 | }
57 |
58 | [HttpGet("{id}/addresses", Name = "GetAddressesByClient")]
59 | public IActionResult GetAddressesByClient(Guid id)
60 | {
61 | if (id == Guid.Empty)
62 | {
63 | return BadRequest();
64 | }
65 |
66 | IEnumerable addresses = _bbbContext.Addresses.Where(w => w.ClientId.Equals(id));
67 | IEnumerable addressModels = addresses.Select(f => RestfulAddress(f));
68 |
69 | return Ok(addressModels);
70 | }
71 |
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Controllers/HomeController.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using Microsoft.AspNetCore.Mvc;
3 | using Microsoft.AspNetCore.Mvc.Infrastructure;
4 | using Microsoft.Extensions.Logging;
5 |
6 | using AutoMapper;
7 |
8 | using BaldBeardedBuilder.HATEOAS.Models;
9 |
10 | namespace BaldBeardedBuilder.HATEOAS.Controllers
11 | {
12 | [ApiController]
13 | [Route("api")]
14 | public class HomeController : RestControllerBase
15 | {
16 | private readonly ILogger _logger;
17 |
18 | public HomeController(ILogger logger, IActionDescriptorCollectionProvider actionDescriptorCollectionProvider, IMapper mapper)
19 | : base(actionDescriptorCollectionProvider, mapper)
20 | {
21 | _logger = logger;
22 | }
23 |
24 | [HttpGet(Name = "GetRoot")]
25 | public IActionResult GetRoot()
26 | {
27 | RootModel rootModel = new RootModel();
28 | rootModel.Links.Add(
29 | UrlLink("addresses", "GetAddresses", null));
30 |
31 | rootModel.Links.Add(
32 | UrlLink("clients", "GetClients", null));
33 |
34 | return Ok(rootModel);
35 | }
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Controllers/RestControllerBase.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using Microsoft.AspNetCore.Mvc;
5 | using Microsoft.AspNetCore.Mvc.Abstractions;
6 | using Microsoft.AspNetCore.Mvc.ActionConstraints;
7 | using Microsoft.AspNetCore.Mvc.Infrastructure;
8 |
9 | using AutoMapper;
10 |
11 | using BaldBeardedBuilder.HATEOAS.Models;
12 | using BaldBeardedBuilder.HATEOAS.Lib.Entities;
13 |
14 | namespace BaldBeardedBuilder.HATEOAS.Controllers
15 | {
16 | public class RestControllerBase : ControllerBase
17 | {
18 | private readonly IReadOnlyList _routes;
19 | private readonly IMapper _mapper;
20 |
21 | public RestControllerBase(IActionDescriptorCollectionProvider actionDescriptorCollectionProvider, IMapper mapper)
22 | {
23 | _routes = actionDescriptorCollectionProvider.ActionDescriptors.Items;
24 | _mapper = mapper;
25 | }
26 |
27 | internal Link UrlLink(string relation, string routeName, object values)
28 | {
29 | var route = _routes.FirstOrDefault(f => f.AttributeRouteInfo.Name.Equals(routeName));
30 | var method = route.ActionConstraints.OfType().First().HttpMethods.First();
31 | var url = Url.Link(routeName, values).ToLower();
32 | return new Link(url, relation, method);
33 | }
34 |
35 | internal AddressModel RestfulAddress(Address address)
36 | {
37 | AddressModel addressModel = _mapper.Map(address);
38 |
39 | addressModel.Links.Add(
40 | UrlLink("all", "GetAddresses", null));
41 |
42 | addressModel.Links.Add(
43 | UrlLink("_self", "GetAddressAsync", new { id = addressModel.Id }));
44 |
45 | addressModel.Links.Add(
46 | UrlLink("client", "GetClientAsync", new { id = addressModel.ClientId }));
47 |
48 | return addressModel;
49 | }
50 |
51 | internal ClientModel RestfulClient(Client client)
52 | {
53 | ClientModel clientModel = _mapper.Map(client);
54 |
55 | clientModel.Links.Add(
56 | UrlLink("all", "GetClients", null));
57 |
58 | clientModel.Links.Add(
59 | UrlLink("_self", "GetClientAsync", new { id = clientModel.Id }));
60 |
61 | clientModel.Links.Add(
62 | UrlLink("addresses", "GetAddressesByClient", new { id = clientModel.Id }));
63 |
64 | return clientModel;
65 | }
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Models/AddressModel.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace BaldBeardedBuilder.HATEOAS.Models
4 | {
5 | public class AddressModel : RestModelBase
6 | {
7 | public Guid Id { get; set; }
8 | public string StreetAddress { get; set; }
9 | public string City { get; set; }
10 | public string PostalCode { get; set; }
11 | public Guid ClientId { get; set; }
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Models/ClientModel.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace BaldBeardedBuilder.HATEOAS.Models
4 | {
5 | public class ClientModel : RestModelBase
6 | {
7 | public Guid Id { get; set; }
8 | public string Name { get; set; }
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Models/Link.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace BaldBeardedBuilder.HATEOAS.Models
4 | {
5 | public class Link
6 | {
7 | public Link(string href, string rel, string type)
8 | {
9 | Href = href;
10 | Rel = rel;
11 | Type = type;
12 | }
13 |
14 | public string Href { get; private set; }
15 | public string Rel { get; private set; }
16 | public string Type { get; private set; }
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Models/RestModelBase.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 |
4 | namespace BaldBeardedBuilder.HATEOAS.Models
5 | {
6 | public abstract class RestModelBase
7 | {
8 | public List Links { get; set; } = new List();
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Models/RootModel.cs:
--------------------------------------------------------------------------------
1 | using System;
2 |
3 | namespace BaldBeardedBuilder.HATEOAS.Models
4 | {
5 | public class RootModel : RestModelBase
6 | {
7 | }
8 | }
9 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Program.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using System.Collections.Generic;
3 | using System.Linq;
4 | using System.Threading.Tasks;
5 | using BaldBeardedBuilder.HATEOAS.Lib.Data;
6 | using Microsoft.AspNetCore.Hosting;
7 | using Microsoft.Extensions.Configuration;
8 | using Microsoft.Extensions.DependencyInjection;
9 | using Microsoft.Extensions.Hosting;
10 | using Microsoft.Extensions.Logging;
11 |
12 | namespace BaldBeardedBuilder.HATEOAS
13 | {
14 | public class Program
15 | {
16 | public static void Main(string[] args)
17 | {
18 | var host = CreateHostBuilder(args).Build();
19 |
20 | CreateDbIfNotExists(host);
21 |
22 | host.Run();
23 | }
24 |
25 | private static void CreateDbIfNotExists(IHost host)
26 | {
27 | using (var scope = host.Services.CreateScope())
28 | {
29 | var services = scope.ServiceProvider;
30 |
31 | try
32 | {
33 | var context = services.GetRequiredService();
34 | context.Database.EnsureCreated();
35 | context.SeedData();
36 | }
37 | catch (Exception ex)
38 | {
39 | var logger = services.GetRequiredService>();
40 | logger.LogError(ex, "An error occurred creating the DB.");
41 | }
42 | }
43 | }
44 |
45 | public static IHostBuilder CreateHostBuilder(string[] args) =>
46 | Host.CreateDefaultBuilder(args)
47 | .ConfigureWebHostDefaults(webBuilder =>
48 | {
49 | webBuilder.UseStartup();
50 | });
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Properties/launchSettings.json:
--------------------------------------------------------------------------------
1 | {
2 | "iisSettings": {
3 | "windowsAuthentication": false,
4 | "anonymousAuthentication": true,
5 | "iisExpress": {
6 | "applicationUrl": "http://localhost:63871",
7 | "sslPort": 44320
8 | }
9 | },
10 | "$schema": "http://json.schemastore.org/launchsettings.json",
11 | "profiles": {
12 | "BaldBeardedBuilder.HATEOAS": {
13 | "commandName": "Project",
14 | "launchBrowser": true,
15 | "launchUrl": "api",
16 | "environmentVariables": {
17 | "ASPNETCORE_ENVIRONMENT": "Development"
18 | },
19 | "applicationUrl": "https://localhost:5001;http://localhost:5000"
20 | }
21 | }
22 | }
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/Startup.cs:
--------------------------------------------------------------------------------
1 | using System;
2 | using Microsoft.AspNetCore.Builder;
3 | using Microsoft.AspNetCore.Hosting;
4 | using Microsoft.EntityFrameworkCore;
5 | using Microsoft.Extensions.Configuration;
6 | using Microsoft.Extensions.DependencyInjection;
7 | using Microsoft.Extensions.Hosting;
8 |
9 | using AutoMapper;
10 | using BaldBeardedBuilder.HATEOAS.Lib.Data;
11 |
12 | namespace BaldBeardedBuilder.HATEOAS
13 | {
14 | public class Startup
15 | {
16 | public Startup(IConfiguration configuration)
17 | {
18 | Configuration = configuration;
19 | }
20 |
21 | public IConfiguration Configuration { get; }
22 |
23 | // This method gets called by the runtime. Use this method to add services to the container.
24 | public void ConfigureServices(IServiceCollection services)
25 | {
26 | services.AddControllers();
27 |
28 | services.AddAutoMapper(typeof(Startup));
29 | services.AddDbContext(options =>
30 | options.UseInMemoryDatabase(databaseName: "bbb"));
31 | }
32 |
33 | // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
34 | public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
35 | {
36 | if (env.IsDevelopment())
37 | {
38 | app.UseDeveloperExceptionPage();
39 | }
40 |
41 | app.UseHttpsRedirection();
42 |
43 | app.UseRouting();
44 |
45 | app.UseAuthorization();
46 |
47 | app.UseEndpoints(endpoints =>
48 | {
49 | endpoints.MapControllers();
50 | });
51 | }
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/appsettings.Development.json:
--------------------------------------------------------------------------------
1 | {
2 | "Logging": {
3 | "LogLevel": {
4 | "Default": "Debug",
5 | "System": "Information",
6 | "Microsoft": "Information"
7 | }
8 | }
9 | }
10 |
--------------------------------------------------------------------------------
/src/BaldBeardedBuilder.HATEOAS/appsettings.json:
--------------------------------------------------------------------------------
1 | {
2 | "Logging": {
3 | "LogLevel": {
4 | "Default": "Information",
5 | "Microsoft": "Warning",
6 | "Microsoft.Hosting.Lifetime": "Information"
7 | }
8 | },
9 | "AllowedHosts": "*"
10 | }
11 |
--------------------------------------------------------------------------------