update docs -1

Author: jaredcnance

docs/.gitignore

@@ -0,0 +1 @@
+_site/

docs/GET_Articles_Response

@@ -0,0 +1 @@
+{"data":[]}

docs/api/.gitignore

@@ -0,0 +1,4 @@
+###############
+#  temp file  #
+###############
+*.yml

src/JsonApiDotNetCore/api/.manifest renamed to docs/api/.manifest

@@ -3,8 +3,8 @@
         {
             "src": [
                 {
-                    "files": [ "**.csproj" ],
-                    "src": "C:\\Users\\jnance\\dev\\json-api-dotnet-core\\src\\JsonApiDotNetCore"
+                    "files": [ "**/JsonApiDotNetCore.csproj" ],
+                    "src": "../"
                 }
             ],
             "dest": "api",
@@ -21,8 +21,9 @@
             },
             {
                 "files": [
-                    "articles/**.md",
-                    "articles/**/toc.yml",
+                    "getting-started/**.md",
+                    "getting-started/**/toc.yml",
+                    "request-examples/**.md",
                     "toc.yml",
                     "*.md"
                 ]

src/JsonApiDotNetCore/api/index.md renamed to docs/api/index.md

@@ -0,0 +1,29 @@
+#!/bin/bash
+# generates ./request-examples documents
+
+function cleanup() {
+    kill -9 $(lsof -ti tcp:5001) &2>/dev/null
+}
+
+cleanup
+dotnet run -p ../src/Examples/GettingStarted/GettingStarted.csproj &
+app_pid=$!
+
+
+{ # try
+    echo "Started app with PID $app_pid"
+
+    sleep 5
+
+    echo "sleep over"
+
+    for path in ./request-examples/*.sh; do
+        op_name=$(basename "$path" .sh | sed 's/.*-//')
+        echo $op_name
+        bash $path | jq . > "./request-examples/$op_name-Response.json"
+    done
+}
+
+# docfx metadata
+
+cleanup

src/JsonApiDotNetCore/docfx.json renamed to docs/docfx.json

@@ -0,0 +1,9 @@
+## Installing
+
+...
+
+## Creating a project template
+
+```
+dotnet new jadnc
+```

docs/generate.sh

@@ -0,0 +1,5 @@
+# Introduction
+
+What is this
+
+[!code-csharp[Main](../../src/Examples/OperationsExample/Program.cs)]

docs/generators/index.md

@@ -0,0 +1,36 @@
+# JSON API .Net Core
+
+A [{ json:api }](https://jsonapi.org) web application framework for .Net Core.
+
+## Objectives
+
+### 1. Eliminate Boilerplate
+
+The goal of this package is to facility the development of json:api applications that leverage the full range 
+of features provided by the specification.
+
+Eliminate CRUD boilerplate and provide the following features across all your resource endpoints: 
+
+- Relationship inclusion and navigation
+- Filtering
+- Sorting
+- Pagination
+- Sparse field selection
+- And more...
+
+As an example, with just the following model and controller definitions, you can service all of the following requests:
+
+```http
+GET /articles HTTP/1.1
+Accept: application/vnd.api+json
+```
+
+[!code-csharp[Article](../src/Examples/GettingStarted/Models/Article.cs)]
+
+[!code-csharp[ArticlesController](../src/Examples/GettingStarted/Controllers/ArticlesController.cs)]
+
+### 2. Extensibility
+
+This library relies heavily on an open-generic-based dependency injection model which allows for easy per-resource customization.
+
+

docs/getting-started/intro.md

@@ -0,0 +1 @@
+*.json

src/JsonApiDotNetCore/articles/toc.yml renamed to docs/getting-started/toc.yml

@@ -0,0 +1,11 @@
+curl http://localhost:5001/api/articles         \
+    -H "Accept: application/vnd.api+json"       \
+    -H "Content-Type: application/vnd.api+json" \
+    -d '{
+            "data": {
+                "type": "articles",
+                "attributes": {
+                    "title": "test"
+                }
+            }
+        }'

docs/index.md

@@ -0,0 +1,2 @@
+curl http://localhost:5001/api/articles     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/.gitignore

@@ -0,0 +1,2 @@
+curl http://localhost:5001/api/articles/1     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/000-CREATE_Article.sh

@@ -0,0 +1,19 @@
+# Examples
+
+These requests have been generated against the "GettingStarted" application and are updated on every deployment.
+
+## Create Article
+
+[!code-sh[CREATE](000-CREATE_Article.sh)]
+[!code-json[CREATE](CREATE_Article-Response.json)]
+
+
+## Get All Articles
+
+[!code-sh[GET Request](001-GET_Articles.sh)]
+[!code-json[GET Response](GET_Articles-Response.json)]
+
+## Get Article By Id
+
+[!code-sh[GET Request](002-GET_Article.sh)]
+[!code-json[GET Response](GET_Article-Response.json)]

docs/request-examples/001-GET_Articles.sh

@@ -0,0 +1,10 @@
+- name: Getting Started
+  href: getting-started/
+  
+- name: API
+  href: api/
+  homepage: api/index.md
+
+- name: Request Examples
+  href: request-examples/
+  homepage: request-examples/index.md

docs/request-examples/002-GET_Article.sh

@@ -0,0 +1,16 @@
+using JsonApiDotNetCore.Controllers;
+using JsonApiDotNetCore.Services;
+using Microsoft.Extensions.Logging;
+
+namespace GettingStarted
+{
+    public class ArticlesController : JsonApiController<Article>
+    {
+        public ArticlesController(
+          IJsonApiContext jsonApiContext,
+          IResourceService<Article> resourceService,
+          ILoggerFactory loggerFactory)
+          : base(jsonApiContext, resourceService, loggerFactory)
+        { }
+    }
+}

docs/request-examples/index.md

@@ -0,0 +1,13 @@
+using Microsoft.EntityFrameworkCore;
+
+namespace GettingStarted
+{
+    public class SampleDbContext : DbContext
+    {
+        public SampleDbContext(DbContextOptions<SampleDbContext> options)
+        : base(options)
+        { }
+
+        public DbSet<Article> Articles { get; set; }
+    }
+}

docs/toc.yml

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Folder Include="wwwroot\" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore" Version="2.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="2.1.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="2.1.0" />
+  </ItemGroup>
+
+</Project>

src/Examples/GettingStarted/Controllers/ArticlesController.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Models;
+
+namespace GettingStarted
+{
+    public class Article : Identifiable
+    {
+        [Attr("title")]
+        public string Title { get; set; }
+    }
+}

src/Examples/GettingStarted/Data/SampleDbContext.cs

@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+
+namespace GettingStarted
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            BuildWebHost(args).Run();
+        }
+
+        public static IWebHost BuildWebHost(string[] args) =>
+            WebHost.CreateDefaultBuilder(args)
+                .UseStartup<Startup>()
+                .UseUrls("http://localhost:5001")
+                .Build();
+    }
+}

src/Examples/GettingStarted/GettingStarted.csproj

@@ -0,0 +1,14 @@
+## Sample project
+
+## Usage
+
+`dotnet run` to run the project
+
+You can verify the project is running by checking this endpoint:
+`localhost:5001/api/sample-model`
+
+For further documentation and implementation of a JsonApiDotnetCore Application see the documentation or GitHub page:
+
+Repository: https://github.com/json-api-dotnet/JsonApiDotNetCore
+
+Documentation: https://json-api-dotnet.github.io/

src/Examples/GettingStarted/Models/Article.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.EntityFrameworkCore;
+using JsonApiDotNetCore.Extensions;
+
+namespace GettingStarted
+{
+    public class Startup
+    {
+        // This method gets called by the runtime. Use this method to add services to the container.
+        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddDbContext<SampleDbContext>(options =>
+            {
+                options.UseSqlite("Data Source=sample.db");
+            });
+
+            services.AddJsonApi<SampleDbContext>(options =>
+            {
+                options.Namespace = "api";
+            });
+        }
+
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app, IHostingEnvironment env, SampleDbContext context)
+        {
+            if (env.IsDevelopment())
+            {
+                app.UseDeveloperExceptionPage();
+            }
+
+            context.Database.EnsureDeleted(); // indicies need to be reset
+            context.Database.EnsureCreated();
+
+            app.UseJsonApi();
+        }
+    }
+}