ttu/dotnet-fake-json-server

Fake JSON Server is a Fake REST API that can be used as a Back End for prototyping or as a template for a CRUD Back End.

dotnet-fake-json-server's Issues

Add custom response

I need custom responses to mock an api, the functionality is like this typicode/json-server#118

Add support for Accept header and CSV type

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept

Implementation in branch: https://github.com/ttu/dotnet-fake-json-server/tree/%2357-accept-csv

DELETE operations put server in Bad State

DELETE /api/{collection}/{id}
succeeds only once. If there are other collections, server will return 500.

Sample data.json:

{
  "tests": [
    {
      "value": [
        "Test1"
      ],
      "id": 0
    }
  ],
  "items": [
    {
      "description": "some_description",
      "createdDate": "0001-01-01T00:00:00",
      "id": 0
    }
  ],
  "programs": [
    {
      "id": 0,
      "canOverride": false,
      "enabled": true,
      "version": null
    }
  ]
}

Operation 1
DELETE /api/tests/0
result: 204

Operation 2
DELETE /api/items/0
result: 500

Support numeric string for collection identifiers

If a collection has an item with "id": "MTgwODA3MA" and another item with "id": "510". Then GET /api/collection/510 will throw an exception in DynamicController.GetItem on the lamba method ObjectHelper.GetFieldValue(e, _dsSettings.IdField) == id :

Microsoft.CSharp.RuntimeBinder.RuntimeBinderException: 'Operator '==' cannot be applied to operands of type 'string' and 'int''

Do you think it would be interesting to support collections with such numeric string as identifiers?

Thank you very much for this library. It's very interesting, I use it for learning purposes and prototyping.

Fix Vue from index.html

1. Start the server
2. Go to root, e.g. http://localhost:57602

Error:

Page:
https://github.com/ttu/dotnet-fake-json-server/blob/master/FakeServer/wwwroot/index.html

Example with Vue 3 from e.g.
https://github.com/ttu/multi-camera-system/blob/main/src/templates/index.html

Create a self-contained package from a tag for most common runtimes

Scripts:
https://github.com/ttu/dotnet-fake-json-server/blob/master/release.bat
https://github.com/ttu/dotnet-fake-json-server/blob/master/release.sh

Specifying a data file with the "--file" argument causes a duplicate key exception

Steps to reproduce:

1. Clone the repo
2. cd into the dotnet-fake-json-server/FakeServer directory
3. Create a file called "test.json"
4. Run the application with the following command: dotnet run --file "test.json"

I received the following trace after dotnet crashed:

PS C:\Users\aschuhardt\dotnet-fake-json-server\FakeServer> dotnet run --file "test.json"
Using launch settings from C:\Users\aschuhardt\dotnet-fake-json-server\FakeServer\Properties\launchSettings.json...
File: test.json

Unhandled Exception: System.ArgumentException: An item with the same key has already been added. Key: file
   at System.ThrowHelper.ThrowAddingDuplicateWithKeyArgumentException(Object key)
   at System.Collections.Generic.Dictionary`2.TryInsert(TKey key, TValue value, InsertionBehavior behavior)
   at System.Collections.Generic.Dictionary`2.Add(TKey key, TValue value)
   at FakeServer.Program.Main(String[] args) in C:\Users\aschuhardt\dotnet-fake-json-server\FakeServer\Program.cs:line 38

Cause:

This line adds a key "file" regardless of whether one has been added as a result of the command-line argument

Add functionality: HEAD HTTP method

HEAD methods don't return ETag header

HEAD method should use same method as GET from DynamicController, so ETagMiddleware has the response body and can add ETag header. Framework will remove the body later.

Extend support for static files

Current functionality serves files from wwwroot
https://github.com/ttu/dotnet-fake-json-server#static-files

Should work same way as e.g. Node's Serve
https://www.npmjs.com/package/serve

$ npm install -g serve

# Server all files from root
$ serve -s .

Usage could be like this:

$ dotnet install --global FakeServer

# Server files from root
$ fake-server --serve .

# Server files from specific folder
$ fake-server --serve ./files
$ fake-server -s ./files
$ fake-server -s C:\temp\files
$ fake-server -s /home/timmy/app/dist

Update target to 2.1 and remove Microsoft.DotNet.Watcher.Tools cli tool reference

Add functionality - GraphQL mutations

Add authentication data to appsettings.json

Authentication data should be either in authentication.json or in appsettings.json

Create new appsettings.json from command line

Add init command line parameter that will create default appsettings.json

$ fake-server --init

$ dotnet run --init

This command should be used with global tool as then appsettings.json is not located in the startup directory.

urls command line parameter doesn't work

Add functionality - REST: Sort & direction

Follow guide from Zalando:

sort — comma-separated list of fields to sort. To indicate sorting direction, fields my prefixed with + (ascending) or - (descending, default), e.g. /sales-orders?sort=+id

Sort user by age (descending)

/users?sort=age
/users?sort=-age

Sort user by age (ascending)

/users?sort=+age

GET /api/{object} support

It works well with collections but it really needs to support JSON objects as endpoint like so:

We have data.json file:

`{
  "my_test_request": {
    "has_access": true,
    "token": "09832145kndse89745",
    "name": "Instagram Honey",
    "data_array": [
     "beer", "disco", "fun"
    ]
  }
}`

GET http://localhost:57602/api/my_test_request

And as response:

 {
    "has_access": true,
    "token": "09832145kndse89745",
    "name": "Instagram Honey",
    "data_array": [
     "beer", "disco", "fun"
    ]
  }

Update to ASP.NET Core 2.0

Authentication require changes aspnet/Security#1338

Upgrade McMaster.Extensions.CommandLineUtils to version 4.x

Error when upgrading from current version 3.1.0 to 4.0.2

FakeServer
  Program.cs(136, 44): [CS0411] The type arguments for method 'ConfigurationExtensions.Add<TSource>(IConfigurationBuilder, Action<TSource>)' cannot be inferred from the usage. Try specifying the type arguments explicitly.
  Program.cs(137, 44): [CS0411] The type arguments for method 'ConfigurationExtensions.Add<TSource>(IConfigurationBuilder, Action<TSource>)' cannot be inferred from the usage. Try specifying the type arguments explicitly.
  Program.cs(156, 54): [CS1061] 'IReadOnlyList<string>' does not contain a definition for 'ToArray' and no accessible extension method 'ToArray' accepting a first argument of type 'IReadOnlyList<string>' could be found (are you missing a using directive or an assembly reference?)

https://github.com/ttu/dotnet-fake-json-server/blob/master/FakeServer/Program.cs#L136

Find the correct way to add arguments. Maybe will work with app.Arguments.Add ?

Update intergration tests to use WebAppliationFactory

https://docs.microsoft.com/en-us/aspnet/core/testing/integration-testing

Add command line parameter - version

Add command line parameter to show current Assembly version.

Implement use case

• -v/--version: print version, exit program

Controller Path/Tree Support

using a web service tree with controller paths like:

garage/v3.0/storage/Bins
garage/v3.0/storage/Shelves
garage/v3.0/workbench/Tools

I haven't been able to figure out how to mock these, even manually editing datastore.json as follows and calling Reload:

{ "garage/v3.0/storage/Bins": [ { "Type": "Large", "id": 0 }, { "Type": "Small", "id": 1 } ] }

I see there is support for nested items, but this requires specifying an item ID at each level which will not match the paths used by the real service.

Fix Docker example

https://github.com/ttu/dotnet-fake-json-server#docker

Release unreleased features

Could you release the unreleased features? I'm especially eager to use the "Content negotiation with Accept-header and support for CSV and XML" feature.

Add JSON Patch support for updates

Add support for JSON Patch

http://jsonpatch.com/

Add support for XML output content type

Accept: text/xml or application/xml

Travis CI test (Linux) fail with "System.IO.IOException: The configured user limit (128) on the number of inotify instances has been reached ..."

Unit tests on Travis (Linux) fail with

System.IO.IOException : The configured user limit (128) on the number of inotify instances has been reached, or the per-process limit on the number of open file descriptors has been reached.

Example failing test run:
https://app.travis-ci.com/github/ttu/dotnet-fake-json-server/builds/251835568

Example stack trace:

[xUnit.net 00:02:53.56]     FakeServer.Test.Authentication.TokenAuthenticationSpecs.GetToken_InvalidJsonData [FAIL]
  Failed FakeServer.Test.Authentication.TokenAuthenticationSpecs.GetUsers_Authorized_Logout(tokenType: Json) [1 ms]
  Error Message:
   System.IO.IOException : The configured user limit (128) on the number of inotify instances has been reached, or the per-process limit on the number of open file descriptors has been reached.
  Stack Trace:
     at System.IO.FileSystemWatcher.StartRaisingEvents()
   at Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.TryEnableFileSystemWatcher()
   at Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(String filter)
   at Microsoft.Extensions.Primitives.ChangeToken.OnChange(Func`1 changeTokenProducer, Action changeTokenConsumer)
   at Microsoft.Extensions.Configuration.FileConfigurationProvider..ctor(FileConfigurationSource source)
   at Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.Build(IConfigurationBuilder builder)
   at Microsoft.Extensions.Configuration.ConfigurationBuilder.Build()
   at Microsoft.AspNetCore.Hosting.WebHostBuilder.BuildCommonServices(AggregateException& hostingStartupErrors)
   at Microsoft.AspNetCore.Hosting.WebHostBuilder.Build()
   at Microsoft.AspNetCore.TestHost.TestServer..ctor(IWebHostBuilder builder, IFeatureCollection featureCollection)
   at Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateServer(IWebHostBuilder builder)
   at Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.EnsureServer()
   at Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateDefaultClient(DelegatingHandler[] handlers)
   at Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory`1.CreateClient(WebApplicationFactoryClientOptions options)
   at FakeServer.Test.IntegrationFixture.StartServer(String authenticationType) in /home/travis/build/ttu/dotnet-fake-json-server/FakeServer.Test/IntegrationTestCollection.cs:line 69
   at FakeServer.Test.Authentication.TokenAuthenticationSpecs..ctor(IntegrationFixture fixture) in /home/travis/build/ttu/dotnet-fake-json-server/FakeServer.Test/Authentication/TokenAuthenticationSpecs.cs:line 24

If a key with an empty array value exists in the data source, the api /collectionId endpoint returns the NotFound state.

When there is an empty collection in JSON file, we can get it as a Key by using the Get all endpoint, but api/collectionId endpoint returns notfound status and it is confusing.

The minor change could be that if collection's count in this function (collection = _ds.GetCollection (collectionId)) is 0, the endpoint should return empty array as a result

[Feature] On Republish keep previous data

After I publish, I lost all of my data in the datastore.json. Can we have as a feature datastore.json, not to be refreshed

Reqeust to console and/or file?

Great job on the .NET global tool! Works great!

Is there an option to tell fake server to simply output the request to the console or file?

If not, I'll be happy to try and help. Just point a finger in the best spot to implement the code and I'll make it happen.

Add Table of Contents to README

Tools to create toc e.g.:
https://github.com/ekalinin/github-markdown-toc
https://ecotrust-canada.github.io/markdown-toc/

Toc should look like this:

Table of Contents

• Test
  • TestA
• Test2

Test

lorem ipsum

TestA

lorem ipsum

Test2

Fix XML element naming for collections and single items

Regardless of collection naming, elements in XML should be singularized / pluralized.

E.g. for endpoints
/api/family
/api/families

XML should be:

<families>
  <family>
    <id>

Current implementation has e.g. for /api/families

<families>
  <families_0>
    <id>

for /api/family

<family>
  <family_0>
    <id>

Implementation:

dotnet-fake-json-server/FakeServer/Common/Formatters/XmlOutputFormatter.cs

Line 65 in 9e37425

var itemName = ObjectHelper.GetCollectionFromPath(context.HttpContext.Request.Path.Value);

dotnet-fake-json-server/FakeServer/Common/Formatters/XmlOutputFormatter.cs

Line 55 in 9e37425

var children = itemCollection.Select((i, idx) => ((ExpandoObject)i).Aggregate(new XElement($"{name}_{idx}"), HandleExpandoField));

dotnet-fake-json-server/FakeServer/Common/Formatters/XmlOutputFormatter.cs

Line 39 in 9e37425

var children = innerList.Select((i, idx) => ((ExpandoObject)i).Aggregate(new XElement($"{fields.Key}_{idx}"), HandleExpandoField));

Mayble library like https://www.nuget.org/packages/Pluralize.NET.Core/ will do the trick?

GraphQL should also support request with POST method and Content-Type: application/json

Request handling is in FakeServer/GraphQL/GraphQLMiddleware.cs.

Now middleware supports:

If the "application/graphql" Content-Type header is present, treat the HTTP POST body contents as the GraphQL query string.

Should also support this:

If the "application/json " Content-Type header is present, treat the HTTP POST body contents as a JSON with parameter query having the GraphQL query string.

Method: POST 
Content-Type: application/json 
Body: { "query": "{users{name}}" }

Add functionality - Basic Authentication

Add functionality - REST: Option to use Page and PageSize instead of offset and limit

Broken Auth in Swagger UI

On branch update-to-core-30 the endpoints under Authentification tag in Swagger UI are unusable with various symptoms on the following browsers :

• On Windows 10 with Chrome
• On Windows 10 with Firefox
• On MacOS with Chrome

Those endpoints work fine with cURL commands. The problem comes from Swagger UI.

Note: on branch master with .NET Core 2.2, despite the web browser receives the auth token, the Swagger UI does not display the response. Is it important to fix that, or should we focus our effort on .NET Core 3?

Add Response Caching

Add caching. with Response Caching Middleware or with custom middleware
https://docs.microsoft.com/en-us/aspnet/core/performance/caching/middleware?tabs=aspnetcore2x

Branch: https://github.com/ttu/dotnet-fake-json-server/tree/add-response-caching

..as a .NET Core global tool?

https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools

That would make installation and usage much easier. Thoughts? I might be able to figure out how to do it if no one else has time.

Add GraphQL examples to Insomnia workspace

Add GraphQL examples to Insomnia workspace.

Workspace has already two query examples:

dotnet-fake-json-server/docs/FakeServer_Insomnia_Workspace.json

Line 12 in 785f6cd

"url": "{{ baseurl }}/graphql",

Add functionality - REST: Select fields

/users?fields=name,age

Add command line parameter - help

Add help command line parameter to list all available commands.

Should implement 2 use cases

• -h/--help argument: List all commands
• Invalid input: Show invalid arguments and list all commands

Recommended to use some helper utility, e.g.
https://github.com/natemcmaster/CommandLineUtils

Update to .NET Core 3.1

Migration guide: https://docs.microsoft.com/en-us/aspnet/core/migration/22-to-30?view=aspnetcore-3.0&tabs=visual-studio

Branch: https://github.com/ttu/dotnet-fake-json-server/tree/update-to-core-30

New System.Text.Json doesn't support all serializations required by Fake Server, so have to use NewtonsoftJson.

TODO:
[ ] Fix Swagger Authentication filters
[x] Fix InputFormatters / Consumes attribute to accept different media types (merge json)
[x] ETagMiddleware doesn't work with PUT methods. Middleware can't change request's method to GET and verify original data.

GraphQL should support requests with GET and POST method and query in the query parameter

Full specification: http://graphql.org/learn/serving-over-http/

Request handling is in FakeServer/GraphQL/GraphQLMiddleware.cs.

Now middleware supports case:

If the "application/graphql" Content-Type header is present, treat the HTTP POST body contents as the GraphQL query string.

Should also support these:

Method: GET
When receiving an HTTP GET request, the GraphQL query should be specified in the "query" query string

/graphql?query={users{name}}

Method: POST
If the "query" query string parameter is present (as in the GET example above), it should be parsed and handled in the same way as the HTTP GET case.

/graphql?query={users{name}}

Merge patch should support nested properties

Should be able to update e.g. only parent with id 1

PATCH /api/families/19/parents/1

{
  "name": "Kyle",
  "work": {
    "companyName": "PAWNAGRA",
    "address": "679 Ebony Court, Loma, Puerto Rico, 7716"
  }
}

Current implementation supports patch only from the root-level e.g. /api/families/19.

Using Id located somewhere else

Hi,

Is there a way to reference an idea inside a collection rather than a straight forward property?
Using your "users" as an example:

"users": [
    {
      "id": 1,
      "name": "James",
      "age": 40,
      "location": "NY",
      "work": {
        "name": "ACME",
        "location": "NY",
        "rating": 2.3
      }
]

To access it I can user users/1 but what if my Id is inside one of the propeties? for eg:

"users": [
    {
      "name": "James",
      "age": 40,
      "location": "NY",
      "work": {
        "id": 1,
        "name": "ACME",
        "location": "NY",
        "rating": 2.3
      }
    }
]

Is there a way to access this record with "users/{id} but when it gets executed it points to "users/work/{id}" ?

Thanks

Add Swagger URL to startup output

Current output

Datastore file: datastore.json
Datastore location: /home/tomi/src/github/dotnet-fake-json-server/FakeServer
Static files: default wwwroot
Hosting environment: Development
Content root path: /home/xxxx/dotnet-fake-json-server/FakeServer
Now listening on: http://localhost:57603
Application started. Press Ctrl+C to shut down.

Add Swagger Open API as a last line.

Now listening on: http://localhost:57603
Application started. Press Ctrl+C to shut down.
Swagger Open API is available on: http://localhost:57603/swagger  

Pretty likely this needs to be done in Startup.cs as we need to be able to check what is the current port in use.

Change current PATCH implementation to require Content-Type application/json+merge-patch

https://tools.ietf.org/id/draft-snell-merge-patch-02.html

Allowed Content-Types:

application/merge-patch+json
application/json+merge-patch

If Content-Type is not allowed, return 415

Integration with external oAuth2 server such as IdentityServer4 or Azure AD

Does your product support JWT for security? Would it be possible to integrate with 3rd party oAuth2 server such as IdentityServer4 or Azure AD for JWT?

Proofread README.md

Fix grammar, spelling etc. errors from README.md

Bad XML tags occuring when getting single family

When using the command "curl -H "Accept: text/xml" http://localhost:57602/api/families/1", it appears that an errant <friends />" tag (not </friends>) appears right before a </child> tag.

      </friends>
    </child>
    <child>
      <name>Katheryn</name>
      <gender>female</gender>
      <age>9</age>
      <friends />
    </child>
  </children>

For the command "curl -H "Accept: text/xml" http://localhost:57602/api/families/0", an errant <children /> tag occurs after </parents>

    </parent>
  </parents>
  <children />
  <address>
    <postNumber>147</postNumber>
    <street>Melba Court</street>

I did some testing and was able to replicate this problem before the changes in XML pluralization, but I wasn't able to find an immediate cause.