Skip to content

Commit 504dfa1

Browse files
jaredcnancejaredcnance
committed
feat(reports): add reports example
1 parent fc7f702 commit 504dfa1

File tree

10 files changed

+435
-0
lines changed

10 files changed

+435
-0
lines changed

‎JsonApiDotnetCore.sln

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkTests", "t
2424
EndProject
2525
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTests", "test\UnitTests\UnitTests.csproj", "{6D4BD85A-A262-44C6-8572-FE3A30410BF3}"
2626
EndProject
27+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Examples", "Examples", "{026FBC6C-AF76-4568-9B87-EC73457899FD}"
28+
EndProject
29+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReportsExample", "src\Examples\ReportsExample\ReportsExample.csproj", "{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}"
30+
EndProject
2731
Global
2832
GlobalSection(SolutionConfigurationPlatforms) = preSolution
2933
Debug|Any CPU = Debug|Any CPU
@@ -94,6 +98,18 @@ Global
9498
{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x64.Build.0 = Release|x64
9599
{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x86.ActiveCfg = Release|x86
96100
{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x86.Build.0 = Release|x86
101+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
102+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|Any CPU.Build.0 = Debug|Any CPU
103+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x64.ActiveCfg = Debug|x64
104+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x64.Build.0 = Debug|x64
105+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x86.ActiveCfg = Debug|x86
106+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x86.Build.0 = Debug|x86
107+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|Any CPU.ActiveCfg = Release|Any CPU
108+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|Any CPU.Build.0 = Release|Any CPU
109+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x64.ActiveCfg = Release|x64
110+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x64.Build.0 = Release|x64
111+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x86.ActiveCfg = Release|x86
112+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x86.Build.0 = Release|x86
97113
EndGlobalSection
98114
GlobalSection(SolutionProperties) = preSolution
99115
HideSolutionNode = FALSE
@@ -105,5 +121,7 @@ Global
105121
{570165EC-62B5-4684-A139-8D2A30DD4475} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
106122
{73DA578D-A63F-4956-83ED-6D7102E09140} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
107123
{6D4BD85A-A262-44C6-8572-FE3A30410BF3} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
124+
{026FBC6C-AF76-4568-9B87-EC73457899FD} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
125+
{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
108126
EndGlobalSection
109127
EndGlobal

‎src/Examples/ReportsExample/.bowerrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"directory": "wwwroot/lib"
3+
}

‎src/Examples/ReportsExample/.gitignore

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.userosscache
8+
*.sln.docstates
9+
10+
# User-specific files (MonoDevelop/Xamarin Studio)
11+
*.userprefs
12+
13+
# Build results
14+
[Dd]ebug/
15+
[Dd]ebugPublic/
16+
[Rr]elease/
17+
[Rr]eleases/
18+
x64/
19+
x86/
20+
build/
21+
bld/
22+
[Bb]in/
23+
[Oo]bj/
24+
25+
# Visual Studio 2015 cache/options directory
26+
.vs/
27+
# Uncomment if you have tasks that create the project's static files in wwwroot
28+
#wwwroot/
29+
30+
# MSTest test Results
31+
[Tt]est[Rr]esult*/
32+
[Bb]uild[Ll]og.*
33+
34+
# NUNIT
35+
*.VisualState.xml
36+
TestResult.xml
37+
38+
# Build Results of an ATL Project
39+
[Dd]ebugPS/
40+
[Rr]eleasePS/
41+
dlldata.c
42+
43+
# DNX
44+
project.lock.json
45+
artifacts/
46+
47+
*_i.c
48+
*_p.c
49+
*_i.h
50+
*.ilk
51+
*.meta
52+
*.obj
53+
*.pch
54+
*.pdb
55+
*.pgc
56+
*.pgd
57+
*.rsp
58+
*.sbr
59+
*.tlb
60+
*.tli
61+
*.tlh
62+
*.tmp
63+
*.tmp_proj
64+
*.log
65+
*.vspscc
66+
*.vssscc
67+
.builds
68+
*.pidb
69+
*.svclog
70+
*.scc
71+
72+
# Chutzpah Test files
73+
_Chutzpah*
74+
75+
# Visual C++ cache files
76+
ipch/
77+
*.aps
78+
*.ncb
79+
*.opendb
80+
*.opensdf
81+
*.sdf
82+
*.cachefile
83+
84+
# Visual Studio profiler
85+
*.psess
86+
*.vsp
87+
*.vspx
88+
*.sap
89+
90+
# TFS 2012 Local Workspace
91+
$tf/
92+
93+
# Guidance Automation Toolkit
94+
*.gpState
95+
96+
# ReSharper is a .NET coding add-in
97+
_ReSharper*/
98+
*.[Rr]e[Ss]harper
99+
*.DotSettings.user
100+
101+
# JustCode is a .NET coding add-in
102+
.JustCode
103+
104+
# TeamCity is a build add-in
105+
_TeamCity*
106+
107+
# DotCover is a Code Coverage Tool
108+
*.dotCover
109+
110+
# NCrunch
111+
_NCrunch_*
112+
.*crunch*.local.xml
113+
nCrunchTemp_*
114+
115+
# MightyMoose
116+
*.mm.*
117+
AutoTest.Net/
118+
119+
# Web workbench (sass)
120+
.sass-cache/
121+
122+
# Installshield output folder
123+
[Ee]xpress/
124+
125+
# DocProject is a documentation generator add-in
126+
DocProject/buildhelp/
127+
DocProject/Help/*.HxT
128+
DocProject/Help/*.HxC
129+
DocProject/Help/*.hhc
130+
DocProject/Help/*.hhk
131+
DocProject/Help/*.hhp
132+
DocProject/Help/Html2
133+
DocProject/Help/html
134+
135+
# Click-Once directory
136+
publish/
137+
138+
# Publish Web Output
139+
*.[Pp]ublish.xml
140+
*.azurePubxml
141+
# TODO: Comment the next line if you want to checkin your web deploy settings
142+
# but database connection strings (with potential passwords) will be unencrypted
143+
*.pubxml
144+
*.publishproj
145+
146+
# NuGet Packages
147+
*.nupkg
148+
# The packages folder can be ignored because of Package Restore
149+
**/packages/*
150+
# except build/, which is used as an MSBuild target.
151+
!**/packages/build/
152+
# Uncomment if necessary however generally it will be regenerated when needed
153+
#!**/packages/repositories.config
154+
155+
# Microsoft Azure Build Output
156+
csx/
157+
*.build.csdef
158+
159+
# Microsoft Azure Emulator
160+
ecf/
161+
rcf/
162+
163+
# Microsoft Azure ApplicationInsights config file
164+
ApplicationInsights.config
165+
166+
# Windows Store app package directory
167+
AppPackages/
168+
BundleArtifacts/
169+
170+
# Visual Studio cache files
171+
# files ending in .cache can be ignored
172+
*.[Cc]ache
173+
# but keep track of directories ending in .cache
174+
!*.[Cc]ache/
175+
176+
# Others
177+
ClientBin/
178+
~$*
179+
*~
180+
*.dbmdl
181+
*.dbproj.schemaview
182+
*.pfx
183+
*.publishsettings
184+
node_modules/
185+
orleans.codegen.cs
186+
187+
# RIA/Silverlight projects
188+
Generated_Code/
189+
190+
# Backup & report files from converting an old project file
191+
# to a newer Visual Studio version. Backup files are not needed,
192+
# because we have git ;-)
193+
_UpgradeReport_Files/
194+
Backup*/
195+
UpgradeLog*.XML
196+
UpgradeLog*.htm
197+
198+
# SQL Server files
199+
*.mdf
200+
*.ldf
201+
202+
# Business Intelligence projects
203+
*.rdl.data
204+
*.bim.layout
205+
*.bim_*.settings
206+
207+
# Microsoft Fakes
208+
FakesAssemblies/
209+
210+
# GhostDoc plugin setting file
211+
*.GhostDoc.xml
212+
213+
# Node.js Tools for Visual Studio
214+
.ntvs_analysis.dat
215+
216+
# Visual Studio 6 build log
217+
*.plg
218+
219+
# Visual Studio 6 workspace options file
220+
*.opt
221+
222+
# Visual Studio LightSwitch build output
223+
**/*.HTMLClient/GeneratedArtifacts
224+
**/*.DesktopClient/GeneratedArtifacts
225+
**/*.DesktopClient/ModelManifest.xml
226+
**/*.Server/GeneratedArtifacts
227+
**/*.Server/ModelManifest.xml
228+
_Pvt_Extensions
229+
230+
# Paket dependency manager
231+
.paket/paket.exe
232+
233+
# FAKE - F# Make
234+
.fake/

‎src/Examples/ReportsExample/Controllers/ReportsController.cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Threading.Tasks;
5+
using Microsoft.AspNetCore.Mvc;
6+
using JsonApiDotNetCore.Controllers;
7+
using JsonApiDotNetCore.Services;
8+
9+
namespace ReportsExample.Controllers
10+
{
11+
[Route("api/[controller]")]
12+
public class ReportsController : BaseJsonApiController<Report, int>
13+
{
14+
public ReportsController(
15+
IJsonApiContext jsonApiContext,
16+
IGetAllService<Report> getAll)
17+
: base(jsonApiContext, getAll: getAll)
18+
{ }
19+
20+
[HttpGet]
21+
public override async Task<IActionResult> GetAsync() => await base.GetAsync();
22+
}
23+
}

‎src/Examples/ReportsExample/Models/Report.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
using JsonApiDotNetCore.Models;
2+
3+
public class Report : Identifiable
4+
{
5+
[Attr("title")]
6+
public string Title { get; set; }
7+
8+
[Attr("complex-type")]
9+
public ComplexType ComplexType { get; set; }
10+
}
11+
12+
public class ComplexType
13+
{
14+
public string CompoundPropertyName { get; set; }
15+
}

‎src/Examples/ReportsExample/Program.cs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
using System.IO;
2+
using Microsoft.AspNetCore.Hosting;
3+
4+
namespace ReportsExample
5+
{
6+
public class Program
7+
{
8+
public static void Main(string[] args)
9+
{
10+
var host = new WebHostBuilder()
11+
.UseKestrel()
12+
.UseContentRoot(Directory.GetCurrentDirectory())
13+
.UseIISIntegration()
14+
.UseStartup<Startup>()
15+
.Build();
16+
17+
host.Run();
18+
}
19+
}
20+
}

‎src/Examples/ReportsExample/ReportsExample.csproj

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<Project Sdk="Microsoft.NET.Sdk.Web">
2+
3+
<PropertyGroup>
4+
<TargetFramework>netcoreapp1.0</TargetFramework>
5+
<RuntimeFrameworkVersion>1.1.1</RuntimeFrameworkVersion>
6+
<PackageTargetFallback>$(PackageTargetFallback);dotnet5.6;portable-net45+win8</PackageTargetFallback>
7+
</PropertyGroup>
8+
9+
<ItemGroup>
10+
<Folder Include="wwwroot\" />
11+
</ItemGroup>
12+
13+
<ItemGroup>
14+
<ProjectReference Include="../../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
15+
</ItemGroup>
16+
17+
<ItemGroup>
18+
<PackageReference Include="Microsoft.AspNetCore" Version="1.1.2" />
19+
<PackageReference Include="Microsoft.AspNetCore.Mvc" Version="1.1.3" />
20+
<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.1.2" />
21+
<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="1.1.0" />
22+
<PackageReference Include="Npgsql" Version="3.2.2" />
23+
<PackageReference Include="Dapper" Version="1.50.2" />
24+
</ItemGroup>
25+
26+
</Project>

0 commit comments

Comments
 (0)