saule

Saule

Saule ist eine JSON-API-Bibliothek (Version 1.0) für ASP.Net Web API 2. Installieren Sie Saule mit NuGet:

Install-Package saule

Besuchen Sie die Dokumentationswebsite

Um Saule verwenden zu können, müssen Sie Ressourcen definieren, die die Informationen zu Ihrer Domäne enthalten:

 öffentliche Klasse PersonResource: ApiResource{ public PersonResource() { Attribute("FirstName");        Attribute("Nachname");        Attribute("Alter");        BelongsTo<CompanyResource>("Job");        HasMany<PersonResource>("Friends");    }}public class CompanyResource : ApiResource{ public CompanyResource() { Attribute("Name");        Attribute("NumberOfEmployees");    }}

Sie können diese dann verwenden, um jede Klasse in Json Api zu serialisieren (sofern Ihre Klasse Eigenschaften mit denselben Namen wie in Ihrem Modell hat):

 öffentliche Klasse PersonController: ApiController{ [HttpGet] [ReturnsResource(typeof(PersonResource))] [Route("people/{id}")] public JohnSmith GetPerson(string id) { return new JohnSmith();    }}

 GET http://example.com/people/123{ "data": { "type": "person", "id": "123", "attributes": { "first-name": "John", " Nachname": "Smith", "Alter": 34
    }, „relationships“: { „job“: { „links“: { „self“: „http://example.com/people/123/relationships/job/“, „related“: „http://example .com/people/123/job/"
        }, „data“: { „type“: „company“, „id“: „456“
        }
      }, „friends“: { „links“: { „self“: „http://example.com/people/123/relationships/friends/“, „related“: „http://example.com/people/ 123/Freunde/"
        }, "Daten": [
          { „type“: „person“, „id“: „789“
          }
        ]
      }
    }
  }, "inklusive": [
    { „type“: „company“, „id“: „456“, „attributes“: { „name“: „Awesome, Inc.“, „number-of-employees“: 24
      }
    },
    { „type“: „person“, „id“: „789“, „attributes“: { „first-name“: „Sara“, „last-name“: „Jones“, „age“: 38
      }
    }
  ], „links“: { „self“: „http://example.com/people/123“
  }
}

Die Deserialisierung funktioniert genau wie in der normalen Web-API; Sie müssen nichts Besonderes tun, damit dies funktioniert.

Erstellen einer neuen Version

Führen Sie die folgenden Schritte aus, um eine neue Version zu erstellen:

1. Erstellen Sie einen Zweig mit dem Namen release-v<version> (z. B. release-v1.5 ).

2. Erhöhen Sie die Versionsnummer in appveyor.yml im master

3. Übertragen Sie beide Änderungen und warten Sie auf den Build

4. Kopieren Sie die Versionshinweise in die Versionsbeschreibung auf Github

5. Veröffentlichen Sie die neue Version