Giter Club home page Giter Club logo

sevendigital.api.schema's Introduction

7digital

What is this code?

Schema in C# for public 7digital Api endpoints. These definitions are used by and installed with The Api Wrapper. If you're new, start there.

These definitions can be useful on their own if you want to roll your own http communication to the 7digital Api, but want objects to de-serialise output into. It may also useful as a reference for other languages, when creating objects to deserialise 7digital Api responses into.

Where to get it.

This code is packaged here on nuget, and is a dependency for the Api Wrapper

Notes for coders

  • The code is compiled to .net 4.0 for use in that version or later.
  • To avoid name clashes, the folder name and corresponding namespace is plural, the classes inside it are singular. e.g. class Release in namespace Releases. i.e. The fully qualified name is SevenDigital.Api.Schema.Releases.Release.
  • Use tabs not spaces.
  • In order to make a new package version on nuget.org, you can use the PowerShell script in buildpackage/buildPackage.ps1 You will first need an authorised login on nuget.org, the api key from your nuget account, and the nuget commandline tools from here or similar.

Output generation as XML and json

  • The [XmlElement] or [XmlAttribute] attributes gives the name when generating or reading from xml, the property name (lowercased) is used for json. Both should be meaningful.
  • The [XmlRoot] element is only needed on the root object, i.e. where the [ApiEndpoint] attribute is also found.

sevendigital.api.schema's People

Contributors

anthonysteele avatar scooper91 avatar danhaller avatar darrellmozingo avatar gregsochanik avatar michaelokarimia avatar

Watchers

Daniel Kalotay avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.