Merge pull request #116 from christianhelle/accept-headers-docs

README.md

@@ -114,6 +114,7 @@ The following is an example `.refitter` file
   "generateContracts": true, // Optional. Default=true
   "generateXmlDocCodeComments": true, // Optional. Default=true
   "addAutoGeneratedHeader": true, // Optional. Default=true
+  "addAcceptHeaders": true, // Optional. Default=true
   "returnIApiResponse": false, // Optional. Default=false
   "generateOperationHeaders": true, // Optional. Default=true
   "typeAccessibility": "Public", // Optional. Values=Public|Internal. Default=Public
@@ -134,6 +135,7 @@ The following is an example `.refitter` file
 - `generateContracts` - a boolean indicating whether contracts should be generated. A use case for this is several API clients use the same contracts. Default is `true`
 - `generateXmlDocCodeComments` - a boolean indicating whether XML doc comments should be generated. Default is `true`
 - `addAutoGeneratedHeader` - a boolean indicating whether XML doc comments should be generated. Default is `true`
+- `addAcceptHeaders` -  a boolean indicating whether to add accept headers [Headers("Accept: application/json")]. Default is `true`
 - `returnIApiResponse` - a boolean indicating whether to return `IApiResponse<T>` objects. Default is `false`
 - `generateOperationHeaders` - a boolean indicating whether to use operation headers in the generated methods. Default is `true`
 - `typeAccessibility` - the generated type accessibility. Possible values are `Public` and `Internal`. Default is `Public`

src/Refitter.Core/RefitGeneratorSettings.cs

@@ -56,7 +56,7 @@ public class RefitGeneratorSettings
     public bool AddAutoGeneratedHeader { get; set; } = true;
 
     /// <summary>
-    /// Gets or sets a value indicating whether to add auto-generated header.
+    /// Gets or sets a value indicating whether to add accept headers [Headers("Accept: application/json")].
     /// </summary>
     [JsonPropertyName("addAcceptHeaders")]
     [JsonProperty("addAcceptHeaders")]

src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/Refitter.g.cs

@@ -127,7 +127,7 @@ public interface ISwaggerPetstore
 
 //----------------------
 // <auto-generated>
-//     Generated using the NSwag toolchain v13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0)) (http://NSwag.org)
+//     Generated using the NSwag toolchain v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0)) (http://NSwag.org)
 // </auto-generated>
 //----------------------
 
@@ -140,14 +140,15 @@ public interface ISwaggerPetstore
 #pragma warning disable 8073 // Disable "CS8073 The result of the expression is always 'false' since a value of type 'T' is never equal to 'null' of type 'T?'"
 #pragma warning disable 3016 // Disable "CS3016 Arrays as attribute arguments is not CLS-compliant"
 #pragma warning disable 8603 // Disable "CS8603 Possible null reference return"
+#pragma warning disable 8604 // Disable "CS8604 Possible null reference argument for parameter"
 
 namespace Refitter.Tests.AdditionalFiles.NoFilename
 {
     using System = global::System;
 
 
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Order
     {
 
@@ -197,7 +198,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Customer
     {
 
@@ -227,7 +228,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Address
     {
 
@@ -262,7 +263,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Category
     {
 
@@ -287,7 +288,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class User
     {
 
@@ -346,7 +347,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Tag
     {
 
@@ -371,7 +372,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Pet
     {
 
@@ -423,7 +424,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class ApiResponse
     {
 
@@ -453,7 +454,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum Status
     {
 
@@ -468,7 +469,7 @@ public enum Status
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum OrderStatus
     {
 
@@ -483,7 +484,7 @@ public enum OrderStatus
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum PetStatus
     {
 
@@ -498,7 +499,7 @@ public enum PetStatus
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class FileParameter
     {
         public FileParameter(System.IO.Stream data)
@@ -537,3 +538,4 @@ public FileParameter(System.IO.Stream data, string fileName, string contentType)
 #pragma warning restore 8073
 #pragma warning restore 3016
 #pragma warning restore 8603
+#pragma warning restore 8604

src/Refitter.SourceGenerator.Tests/AdditionalFiles/Generated/SwaggerPetstoreSingleInterface.g.cs

@@ -127,7 +127,7 @@ public interface ISwaggerPetstore
 
 //----------------------
 // <auto-generated>
-//     Generated using the NSwag toolchain v13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0)) (http://NSwag.org)
+//     Generated using the NSwag toolchain v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0)) (http://NSwag.org)
 // </auto-generated>
 //----------------------
 
@@ -140,14 +140,15 @@ public interface ISwaggerPetstore
 #pragma warning disable 8073 // Disable "CS8073 The result of the expression is always 'false' since a value of type 'T' is never equal to 'null' of type 'T?'"
 #pragma warning disable 3016 // Disable "CS3016 Arrays as attribute arguments is not CLS-compliant"
 #pragma warning disable 8603 // Disable "CS8603 Possible null reference return"
+#pragma warning disable 8604 // Disable "CS8604 Possible null reference argument for parameter"
 
 namespace Refitter.Tests.AdditionalFiles.SingeInterface
 {
     using System = global::System;
 
 
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Order
     {
 
@@ -197,7 +198,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Customer
     {
 
@@ -227,7 +228,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Address
     {
 
@@ -262,7 +263,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Category
     {
 
@@ -287,7 +288,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class User
     {
 
@@ -346,7 +347,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Tag
     {
 
@@ -371,7 +372,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class Pet
     {
 
@@ -423,7 +424,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class ApiResponse
     {
 
@@ -453,7 +454,7 @@ public IDictionary<string, object> AdditionalProperties
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum Status
     {
 
@@ -468,7 +469,7 @@ public enum Status
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum OrderStatus
     {
 
@@ -483,7 +484,7 @@ public enum OrderStatus
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public enum PetStatus
     {
 
@@ -498,7 +499,7 @@ public enum PetStatus
 
     }
 
-    [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
+    [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v10.0.0.0))")]
     public partial class FileParameter
     {
         public FileParameter(System.IO.Stream data)
@@ -537,3 +538,4 @@ public FileParameter(System.IO.Stream data, string fileName, string contentType)
 #pragma warning restore 8073
 #pragma warning restore 3016
 #pragma warning restore 8603
+#pragma warning restore 8604

src/Refitter.SourceGenerator/README.md

@@ -1,22 +1,28 @@
-# Refitter Source Generator
+## Source Generator
 
-A C# Source Generator that uses [Refitter](https://github.com/christianhelle/refitter) for generating a REST API Client using the [Refit](https://github.com/reactiveui/refit) library. Refitter can generate the Refit interface from OpenAPI specifications
+Refitter is available as a C# Source Generator that uses the [Refitter.Core](https://github.com/christianhelle/refitter.core) library for generating a REST API Client using the [Refit](https://github.com/reactiveui/refit) library. Refitter can generate the Refit interface from OpenAPI specifications
 
-## Installation
+The Refitter source generator is a bit untraditional in a sense that it creates a folder called `Generated` in the same location as the `.refitter` file and generates files to disk under the `Generated` folder. The source generator output should be included in the project and committed to source control. This is done because there is no other way to trigger the Refit source generator to pickup the Refitter generated code 
+
+***(Translation: I couldn't for the life of me figure how to get that to work, sorry)***
+
+### Installation
 
 The source generator is distributed as a NuGet package and should be installed to the project that will contain the generated code
 
 ```shell
 dotnet add package Refitter.SourceGenerator
 ```
 
-## Usage
+### Usage
 
 This source generator generates code based on any `.refitter` file included to the project as `AdditionalFiles`.
 
 The generator can automatically detect all `.refitter` files inside the project that referenced the `Refitter.SourceGenerator` package and there is no need to include them manually as `AdditionalFiles`
 
-## File format
+### .Refitter File format
+
+The following is an example `.refitter` file
 
 ```js
 {
@@ -29,12 +35,13 @@ The generator can automatically detect all `.refitter` files inside the project
   "generateContracts": true, // Optional. Default=true
   "generateXmlDocCodeComments": true, // Optional. Default=true
   "addAutoGeneratedHeader": true, // Optional. Default=true
+  "addAcceptHeaders": true, // Optional. Default=true
   "returnIApiResponse": false, // Optional. Default=false
   "generateOperationHeaders": true, // Optional. Default=true
   "typeAccessibility": "Public", // Optional. Values=Public|Internal. Default=Public
   "useCancellationTokens": false, // Optional. Default=false
   "useIsoDateFormat": false, // Optional. Default=false
-  "multipleInterfaces": "ByEndpoint", // Optional. Values=Unset|ByEndpoint|ByTag. Default=Unset
+  "multipleInterfaces": "ByEndpoint", // Optional. May be one of "ByEndpoint" or "ByTag"
   "additionalNamespaces": [ // Optional
     "Namespace1",
     "Namespace2"
@@ -49,6 +56,7 @@ The generator can automatically detect all `.refitter` files inside the project
 - `generateContracts` - a boolean indicating whether contracts should be generated. A use case for this is several API clients use the same contracts. Default is `true`
 - `generateXmlDocCodeComments` - a boolean indicating whether XML doc comments should be generated. Default is `true`
 - `addAutoGeneratedHeader` - a boolean indicating whether XML doc comments should be generated. Default is `true`
+- `addAcceptHeaders` -  a boolean indicating whether to add accept headers [Headers("Accept: application/json")]. Default is `true`
 - `returnIApiResponse` - a boolean indicating whether to return `IApiResponse<T>` objects. Default is `false`
 - `generateOperationHeaders` - a boolean indicating whether to use operation headers in the generated methods. Default is `true`
 - `typeAccessibility` - the generated type accessibility. Possible values are `Public` and `Internal`. Default is `Public`